Re: [PATCH v3 8/8] doc: Split buffer.rst out of api-summary.rst

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




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@xxxxxxxxxxxxx>
> ---
>  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

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html




[Index of Archives]     [Linux Ext4 Filesystem]     [Union Filesystem]     [Filesystem Testing]     [Ceph Users]     [Ecryptfs]     [NTFS 3]     [AutoFS]     [Kernel Newbies]     [Share Photos]     [Security]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux Cachefs]     [Reiser Filesystem]     [Linux RAID]     [NTFS 3]     [Samba]     [Device Mapper]     [CEPH Development]

  Powered by Linux