linux-fsdevel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Tobin C. Harding" <me@tobin.cc>
To: "Tobin C. Harding" <tobin@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Randy Dunlap <rdunlap@infradead.org>,
	linux-doc@vger.kernel.org, linux-fsdevel@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 09/13] docs: filesystems: vfs: Add code-block and txt->RST
Date: Wed, 20 Mar 2019 10:42:00 +1100	[thread overview]
Message-ID: <20190319234200.GA13178@eros.localdomain> (raw)
In-Reply-To: <20190319013526.GA30001@eros.localdomain>

On Tue, Mar 19, 2019 at 12:35:26PM +1100, Tobin C. Harding wrote:
> On Tue, Mar 19, 2019 at 10:14:33AM +1100, Tobin C. Harding wrote:
> > Use code-block for C source code.  With this in place we can rename the
> > .txt file to  .rst.  This introduces a few warnings that will be fixed
> > in proceeding patches.
> > 
> > Add '.. code-block:: c' to C source code snippets.  Rename the file to
> > use rst file suffix.
> 
> I just realised that a better way to document these structs is to do so
> above the actual struct definition in the source file then include those
> docs in the documentation file.

Please either drop this set or only consider patches 1-8 for merge.  I
haven't worked out _exactly_ how to move the docs from
Documentation/filesystems/vfs to the source code files but I've played
with it enough now to feel it is possible and it is definitely better.
Just have to massage Sphinx into agreeing with me.

I thought the whole reason we have docstring comments is because we all
agreed that docs close to code hove more chance of staying relevant.
vfs.txt proves that nicely (docs in it from 2.6 for structs that are
actively used and developed).

Sorry for the noise, one day I'll work these things out _before_ sending
the patches :)

thanks,
Tobin.

  reply	other threads:[~2019-03-19 23:43 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-18 23:14 [PATCH v2 00/13] Convert vfs.txt to vfs.rst Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 01/13] docs: filesystems: vfs: Remove space before tab Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 02/13] docs: filesystems: vfs: Use uniform space after period Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 03/13] docs: filesystems: vfs: Use 72 character column width Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 04/13] docs: filesystems: vfs: Use uniform spacing around headings Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 05/13] docs: filesystems: vfs: Use correct initial heading Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 06/13] docs: filesystems: vfs: Use SPDX identifier Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 07/13] docs: filesystems: vfs: Fix pre-amble indentation Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 08/13] docs: filesystems: vfs: Use list character for lists Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 09/13] docs: filesystems: vfs: Add code-block and txt->RST Tobin C. Harding
2019-03-19  1:35   ` Tobin C. Harding
2019-03-19 23:42     ` Tobin C. Harding [this message]
2019-03-18 23:14 ` [PATCH v2 10/13] docs: filesystems: vfs: Use ticks for listed items Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 11/13] docs: filesystems: vfs: Clean up lists Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 12/13] docs: filesystems: vfs: Do minor grammar fixes Tobin C. Harding
2019-03-18 23:14 ` [PATCH v2 13/13] docs: filesystems: vfs: Use backticks to guard star Tobin C. Harding

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190319234200.GA13178@eros.localdomain \
    --to=me@tobin.cc \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=tobin@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).