linux-ext4 - Re: [RFC PATCH 00/13] ext4: major documentation surgery

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <20180721201453.GC31851@thunk.org>
Date:   Sat, 21 Jul 2018 16:14:53 -0400
From:   "Theodore Y. Ts'o" <tytso@....edu>
To:     "Darrick J. Wong" <darrick.wong@...cle.com>
Cc:     linux-ext4@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [RFC PATCH 00/13] ext4: major documentation surgery

On Sat, Jul 21, 2018 at 11:19:54AM -0700, Darrick J. Wong wrote:
> 
> I pondered that -- maybe leave all the ext4 stuff clustered together,
> but link to it from the actual user/admin guide section?
>

Yeah, I think it makes keep the ext4 (and in the future, xfs, btrfs,
f2fs, etc.) files clustered together.  Is it considered OK for
individual .rst files to be linked from multiple places?

I could also see us wanting to change up the pdf boundaries.  I doubt
someone would want a single pdf with details of the VFS layer, ext4
mount options, ext4 on-disk format, xfs mount options, xfs on-disk
format, btrfs mount options, etc., all in a single "book".

> > I'm not sure what the best way to do that might be, but maybe some of
> > the folks on the linux-doc list will have some suggestions.
> 
> I was thinking about having a separate top-level Filesystems section
> where we could put user/admin guides, on-disk documentation, etc. and
> leave the FS API section alone.

I wonder if part of the problem is calling it "the API section".
Maybe we should be calling it Kernel Internals, or something like
that?

					- Ted

P.S.  Oh, and we probably want to move "The Linux Journalling API" out
of index.rst, and into a separate jbd2.rst file, and give some context
that it is the journalling layer used by ext4 and ocfs2, but it's
certainly not the only Journalling API in the kernel.