public inbox for linux-doc@vger.kernel.org
 help / color / mirror / Atom feed
From: liubaolin <liubaolin12138@163.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Randy Dunlap <rdunlap@infradead.org>,
	skhan@linuxfoundation.org, cyphar@cyphar.com, vbabka@kernel.org,
	surenb@google.com
Cc: linux-kernel@vger.kernel.org, linux-fsdevel@vger.kernel.org,
	linux-doc@vger.kernel.org, Baolin Liu <liubaolin@kylinos.cn>
Subject: Re: [PATCH v2 v2] Documentation: proc: fix section numbering in table of contents
Date: Tue, 28 Apr 2026 18:36:27 +0800	[thread overview]
Message-ID: <2ab135f3-aedf-43ec-b5b1-387776803b9c@163.com> (raw)
In-Reply-To: <87ik9bmphp.fsf@trenco.lwn.net>


在 2026/4/28 16:57, Jonathan Corbet 写道:
> Your use of HTML email almost certainly prevents your messages from
> making it onto the lists; you need to stop doing that.
> 
I apologize, there was a problem with my newly set up email environment 
that caused the HTML email to be sent. I will pay attention to this in 
the future.

> liubaolin <liubaolin12138@163.com> writes:
> 
>>          I mainly work on ext4 kernel development. Recently, I've been
>> implementing a feature that changes the usage of the ext4 proc
>> parameter mb_stats, which requires updating the ext4 proc parameter
>> documentation.  Currently, the ext4 proc parameter documentation is
>> explained in two files: "Documentation/admin-guide/ext4.rst" and
>> "Documentation/filesystems/proc.rst".
>>
>>          However, I found that only the ext4 file system describes the
>> proc parameters in proc.rst, while other file systems such as btrfs
>> and xfs do not describe the proc parameters they use in the file.
>> Personally, I also feel that it is unnecessary to explain the ext4
>> proc parameters in proc.rst.
>>
>>          Therefore, I want to make a change by deleting the "Ext4 file
>> system parameters" section from the proc.rst file.  After
>> modification, the usage and explanation of ext4 proc parameters will
>> only be provided in Documentation/admin-guide/ext4.rst.
> 
> Documenting things twice is obviously not ideal; readers will wonder
> about the truth when they inevitably go out of sync.
> 
>>          If you agree, I will submit a patch to remove the "Ext4 file
>> system parameters" section.  If you disagree, my subsequent
>> modifications to the ext4 proc parameters will be made simultaneously
>> to the two documents: Documentation/admin-guide/ext4.rst and
>> Documentation/filesystems/proc.rst.  I look forward to your comments
>> and replies.
> 
> I think that having a single location for that documentation makes
> sense.  Whether it's in the individual filesystem docs or centrally
> located is up to the filesystem maintainers in the end.  If you move
> that documentation out of Documentation/filesystems/proc.rst, it would
> be good to add links to the filesystem-specific parameters in its place,
> though.
> 
> Longer term, it seems to me that much of what's in that file really
> belongs in the admin guide, though.
> 
> Thanks,
> 
> jon

Okay, thank you for your reply. I will ask the ext4 maintainers, and if 
they agree, I will submit a patch as you suggested.


      reply	other threads:[~2026-04-28 10:38 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-24  9:06 [PATCH v2 v2] Documentation: proc: fix section numbering in table of contents Baolin Liu
2026-04-24 21:12 ` Randy Dunlap
2026-04-27  9:55   ` Jonathan Corbet
2026-04-27 17:00     ` Randy Dunlap
     [not found]     ` <9455d5d6-80b7-4c0a-a569-fef3bd9f1529@163.com>
2026-04-28  8:57       ` Jonathan Corbet
2026-04-28 10:36         ` liubaolin [this message]

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=2ab135f3-aedf-43ec-b5b1-387776803b9c@163.com \
    --to=liubaolin12138@163.com \
    --cc=corbet@lwn.net \
    --cc=cyphar@cyphar.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=liubaolin@kylinos.cn \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    --cc=surenb@google.com \
    --cc=vbabka@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