On 7/13/23 12:59, Tim Small wrote:
As a prospective contributor, whilst the documentation is generally
very
helpful, I found a few minor gaps and inconsistencies. I thought I would strike
while the iron was hot, and attempt to make some improvements. The changes are
mostly minor clarifications, and additional internal references between
articles.
The only new material is a guide to using clangd with the libvirt code base
(since clangd has become a common programming tool, and is particularly useful
for navigating unfamiliar code bases).
On build hosts where gcc is the default compiler, some manual steps are
necessary before clangd will work with the libvirt code, and I thought these
were worth documenting.
Tim Small (10):
docs: Link to main docs directory from Quick Links
docs: Missing "full-stop"/"period" on some bullet items
docs: Link main "contributing" from programming-specific guide
docs: Point to compiling guide from code contribution guide
docs: Add config instructions for clangd with libvirt
docs: Reword "Preparing Patches" to clarify
docs: Advise running CI tests prior to submission
docs: Point to mailing list archives from submitting-patches
docs: Fix deprecated use of implicit meson "setup" command
docs: Reword ninja invocation note to clarify build directory
docs/clangd.rst | 51 +++++++++++++++++++++++++++++++++++++
docs/compiling.rst | 14 +++++-----
docs/contribute.rst | 6 ++---
docs/hacking.rst | 29 ++++++++++++++++++---
docs/index.rst | 2 ++
docs/meson.build | 1 +
docs/submitting-patches.rst | 5 ++++
7 files changed, 96 insertions(+), 12 deletions(-)
create mode 100644 docs/clangd.rst
Thank you! Yeah, our docs are written by developers and it shows.
Reviewed-by: Michal Privoznik <mprivozn(a)redhat.com>
and merged. Congratulations on your first libvirt contribution.
Michal