| Message ID | 20240416031754.4076917-9-willy@infradead.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | Improve buffer head documentation | expand |
On 4/15/24 8:17 PM, Matthew Wilcox (Oracle) wrote: > Buffer heads are no longer a generic filesystem API but an optional > filesystem support library. Make the documentation structure reflect > that, and include the fine documentation kept in buffer_head.h. > We could give a better overview of what buffer heads are all about, > but my enthusiasm for documenting it is limited. > > Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> > --- > Documentation/filesystems/api-summary.rst | 3 --- > Documentation/filesystems/index.rst | 1 + > 2 files changed, 1 insertion(+), 3 deletions(-) > > diff --git a/Documentation/filesystems/api-summary.rst b/Documentation/filesystems/api-summary.rst > index 98db2ea5fa12..cc5cc7f3fbd8 100644 > --- a/Documentation/filesystems/api-summary.rst > +++ b/Documentation/filesystems/api-summary.rst > @@ -56,9 +56,6 @@ Other Functions > .. kernel-doc:: fs/namei.c > :export: > > -.. kernel-doc:: fs/buffer.c > - :export: > - > .. kernel-doc:: block/bio.c > :export: > > diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst > index 1f9b4c905a6a..8f5c1ee02e2f 100644 > --- a/Documentation/filesystems/index.rst > +++ b/Documentation/filesystems/index.rst > @@ -50,6 +50,7 @@ filesystem implementations. > .. toctree:: > :maxdepth: 2 > > + buffer This causes: Documentation/filesystems/index.rst:50: WARNING: toctree contains reference to nonexisting document 'filesystems/buffer' > journalling > fscrypt > fsverity
On 4/16/24 3:18 PM, Randy Dunlap wrote: > > > On 4/15/24 8:17 PM, Matthew Wilcox (Oracle) wrote: >> Buffer heads are no longer a generic filesystem API but an optional >> filesystem support library. Make the documentation structure reflect >> that, and include the fine documentation kept in buffer_head.h. >> We could give a better overview of what buffer heads are all about, >> but my enthusiasm for documenting it is limited. >> >> Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> >> --- >> Documentation/filesystems/api-summary.rst | 3 --- >> Documentation/filesystems/index.rst | 1 + >> 2 files changed, 1 insertion(+), 3 deletions(-) >> >> diff --git a/Documentation/filesystems/api-summary.rst b/Documentation/filesystems/api-summary.rst >> index 98db2ea5fa12..cc5cc7f3fbd8 100644 >> --- a/Documentation/filesystems/api-summary.rst >> +++ b/Documentation/filesystems/api-summary.rst >> @@ -56,9 +56,6 @@ Other Functions >> .. kernel-doc:: fs/namei.c >> :export: >> >> -.. kernel-doc:: fs/buffer.c >> - :export: >> - >> .. kernel-doc:: block/bio.c >> :export: >> >> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst >> index 1f9b4c905a6a..8f5c1ee02e2f 100644 >> --- a/Documentation/filesystems/index.rst >> +++ b/Documentation/filesystems/index.rst >> @@ -50,6 +50,7 @@ filesystem implementations. >> .. toctree:: >> :maxdepth: 2 >> >> + buffer > > This causes: > > Documentation/filesystems/index.rst:50: WARNING: toctree contains reference to nonexisting document 'filesystems/buffer' I added a simple/minimal new buffer.rst file for testing: (needs an SPDX line) --- Documentation/filesystems/buffer.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff -- /dev/null b/Documentation/filesystems/buffer.rst --- /dev/null +++ b/Documentation/filesystems/buffer.rst @@ -0,0 +1,11 @@ + +=========================== +Filesystem buffer head APIs +=========================== + +.. kernel-doc:: include/linux/buffer_head.h + :internal: + +.. kernel-doc:: fs/buffer.c + :export: +
On Tue, Apr 16, 2024 at 03:18:59PM -0700, Randy Dunlap wrote: > On 4/15/24 8:17 PM, Matthew Wilcox (Oracle) wrote: > > Buffer heads are no longer a generic filesystem API but an optional > > filesystem support library. Make the documentation structure reflect > > that, and include the fine documentation kept in buffer_head.h. > > We could give a better overview of what buffer heads are all about, > > but my enthusiasm for documenting it is limited. > > > > Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> > > --- > > Documentation/filesystems/api-summary.rst | 3 --- > > Documentation/filesystems/index.rst | 1 + ... where did my buffer.rst go to? I'll figure it out later/tomorrow and send a new 8/8. > > 2 files changed, 1 insertion(+), 3 deletions(-) > > > > diff --git a/Documentation/filesystems/api-summary.rst b/Documentation/filesystems/api-summary.rst > > index 98db2ea5fa12..cc5cc7f3fbd8 100644 > > --- a/Documentation/filesystems/api-summary.rst > > +++ b/Documentation/filesystems/api-summary.rst > > @@ -56,9 +56,6 @@ Other Functions > > .. kernel-doc:: fs/namei.c > > :export: > > > > -.. kernel-doc:: fs/buffer.c > > - :export: > > - > > .. kernel-doc:: block/bio.c > > :export: > > > > diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst > > index 1f9b4c905a6a..8f5c1ee02e2f 100644 > > --- a/Documentation/filesystems/index.rst > > +++ b/Documentation/filesystems/index.rst > > @@ -50,6 +50,7 @@ filesystem implementations. > > .. toctree:: > > :maxdepth: 2 > > > > + buffer > > This causes: > > Documentation/filesystems/index.rst:50: WARNING: toctree contains reference to nonexisting document 'filesystems/buffer' > > > > journalling > > fscrypt > > fsverity > > -- > #Randy > https://people.kernel.org/tglx/notes-about-netiquette > https://subspace.kernel.org/etiquette.html
diff --git a/Documentation/filesystems/api-summary.rst b/Documentation/filesystems/api-summary.rst index 98db2ea5fa12..cc5cc7f3fbd8 100644 --- a/Documentation/filesystems/api-summary.rst +++ b/Documentation/filesystems/api-summary.rst @@ -56,9 +56,6 @@ Other Functions .. kernel-doc:: fs/namei.c :export: -.. kernel-doc:: fs/buffer.c - :export: - .. kernel-doc:: block/bio.c :export: diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index 1f9b4c905a6a..8f5c1ee02e2f 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -50,6 +50,7 @@ filesystem implementations. .. toctree:: :maxdepth: 2 + buffer journalling fscrypt fsverity
Buffer heads are no longer a generic filesystem API but an optional filesystem support library. Make the documentation structure reflect that, and include the fine documentation kept in buffer_head.h. We could give a better overview of what buffer heads are all about, but my enthusiasm for documenting it is limited. Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org> --- Documentation/filesystems/api-summary.rst | 3 --- Documentation/filesystems/index.rst | 1 + 2 files changed, 1 insertion(+), 3 deletions(-)