]> git.ipfire.org Git - thirdparty/libvirt.git/commit
docs: kbase: internals: Make 'overview' page useful and link to it
authorPeter Krempa <pkrempa@redhat.com>
Thu, 7 Apr 2022 12:08:41 +0000 (14:08 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Tue, 12 Apr 2022 10:53:32 +0000 (12:53 +0200)
commita89b17c2a75cfbaeb9e430f88e0f8a7475eb4f54
treeb2cb09c4849b3fbb0373908ca4ae935a80017189
parentb51afd97e56a6d9436f8706f952ebc6af647773c
docs: kbase: internals: Make 'overview' page useful and link to it

While the content is slightly outdated it's still a good primer on how
an API call traverses through the client library and to the remote
driver.

To make the page useful, this commit:
 - removes the paragraphs which were intended to serve as a directory
   page for the 'internals' subdirectory
 - adds a note saying that some facts might not be up to date
 - adds linking to this page from the kbase directory page
 - adds more monospace formatting around function names

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
docs/kbase/index.rst
docs/kbase/internals/overview.rst