| Message ID | 20210818151313.49992-1-grantseltzer@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | BPF |
| Headers | show |
| Series | Rename libbpf documentation index file | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Not a local patch |
On Wed, Aug 18, 2021 at 8:13 AM grantseltzer <grantseltzer@gmail.com> wrote: > > From: Grant Seltzer <grantseltzer@gmail.com> > > This patch renames a documentation libbpf.rst to index.rst. In order > for readthedocs to pick this file up and properly build the > documentation site. > > It also changes the title type of the ABI subsection in the > naming convention doc. This is so that readthedocs doesn't treat this > section as a seperate document. > > Signed-off-by: Grant Seltzer <grantseltzer@gmail.com> > --- Please don't forget to add [PATCH bpf-next] to your future patches. Also libbpf-related patches should come with "libbpf: " prefix in patch subject. Applied to bpf-next, thanks. > Documentation/bpf/libbpf/{libbpf.rst => index.rst} | 8 ++++++++ > Documentation/bpf/libbpf/libbpf_naming_convention.rst | 2 +- > 2 files changed, 9 insertions(+), 1 deletion(-) > rename Documentation/bpf/libbpf/{libbpf.rst => index.rst} (75%) > > diff --git a/Documentation/bpf/libbpf/libbpf.rst b/Documentation/bpf/libbpf/index.rst > similarity index 75% > rename from Documentation/bpf/libbpf/libbpf.rst > rename to Documentation/bpf/libbpf/index.rst > index 1b1e61d5ead1..4f8adfc3ab83 100644 > --- a/Documentation/bpf/libbpf/libbpf.rst > +++ b/Documentation/bpf/libbpf/index.rst > @@ -3,6 +3,14 @@ > libbpf > ====== > > +For API documentation see the `versioned API documentation site <https://libbpf.readthedocs.io/en/latest/api.html>`_. > + > +.. toctree:: > + :maxdepth: 1 > + > + libbpf_naming_convention > + libbpf_build > + > This is documentation for libbpf, a userspace library for loading and > interacting with bpf programs. > > diff --git a/Documentation/bpf/libbpf/libbpf_naming_convention.rst b/Documentation/bpf/libbpf/libbpf_naming_convention.rst > index 6bf9c5ac7576..9c68d5014ff1 100644 > --- a/Documentation/bpf/libbpf/libbpf_naming_convention.rst > +++ b/Documentation/bpf/libbpf/libbpf_naming_convention.rst > @@ -69,7 +69,7 @@ functions. These can be mixed and matched. Note that these functions > are not reentrant for performance reasons. > > ABI > -========== > +--- > > libbpf can be both linked statically or used as DSO. To avoid possible > conflicts with other libraries an application is linked with, all > -- > 2.31.1 >
diff --git a/Documentation/bpf/libbpf/libbpf.rst b/Documentation/bpf/libbpf/index.rst similarity index 75% rename from Documentation/bpf/libbpf/libbpf.rst rename to Documentation/bpf/libbpf/index.rst index 1b1e61d5ead1..4f8adfc3ab83 100644 --- a/Documentation/bpf/libbpf/libbpf.rst +++ b/Documentation/bpf/libbpf/index.rst @@ -3,6 +3,14 @@ libbpf ====== +For API documentation see the `versioned API documentation site <https://libbpf.readthedocs.io/en/latest/api.html>`_. + +.. toctree:: + :maxdepth: 1 + + libbpf_naming_convention + libbpf_build + This is documentation for libbpf, a userspace library for loading and interacting with bpf programs. diff --git a/Documentation/bpf/libbpf/libbpf_naming_convention.rst b/Documentation/bpf/libbpf/libbpf_naming_convention.rst index 6bf9c5ac7576..9c68d5014ff1 100644 --- a/Documentation/bpf/libbpf/libbpf_naming_convention.rst +++ b/Documentation/bpf/libbpf/libbpf_naming_convention.rst @@ -69,7 +69,7 @@ functions. These can be mixed and matched. Note that these functions are not reentrant for performance reasons. ABI -========== +--- libbpf can be both linked statically or used as DSO. To avoid possible conflicts with other libraries an application is linked with, all