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 for Android: free password hash cracker in your pocket

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

Message-ID: <20180719163236.GA4800@magnolia>
Date:   Thu, 19 Jul 2018 09:32:36 -0700
From:   "Darrick J. Wong" <darrick.wong@...cle.com>
To:     tytso@....edu
Cc:     linux-ext4@...r.kernel.org
Subject: Re: [RFC PATCH 00/13] ext4: major documentation surgery

On Tue, Jul 10, 2018 at 10:16:42AM -0700, Darrick J. Wong wrote:
> Hi all,
> 
> This series converts the existing in-kernel ext4 documentation to rst
> format, links it in with the rest of the kernel's rst documetation, and
> then begins pulling in the contents of the on-disk layout page in the
> wiki.  No changes are made to the text during the import process except
> to flatten the nested tables in the old wiki page, which were very
> difficult to maintain.
> 
> I've built the docs and put them here, in case you hate reading rst:
> https://djwong.org/docs/kdoc/filesystems/ext4/index.html
> 
> The patchset should apply cleanly against 4.18-rc4.  Comments and
> questions are, as always, welcome.

To echo the discussion we just had on the community concall, Ted tried
following the installation instructions in
./Documentation/doc-guide/sphinx.rst, which created a python virtualenv
and installed sphinx 1.4.9.  The build failed with some complaints about
column size or something.

I stated that I'd simply built the documentation with the python3-sphinx
1.6.7 packages in Ubuntu 18.04 and they built fine.  I later tried the
python3-sphinx 1.3.6 packages in Ubuntu 16.04 and that also built fine,
so I'll try following the same instructions that Ted did to see what
happens.  Ted said he'd try the 1.7.5 packages in Debian testing.

FWIW the link above is the output from the 1.6.7 packages on Ubuntu,
having run 'apt install python3-sphinx python3-sphinx-rtd-theme' and
'make htmldocs'.

--D