From: Anand Jain <anand.jain@oracle.com>
To: dsterba@suse.cz, Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>,
linux-btrfs@vger.kernel.org, clm@fb.com
Subject: Re: [PATCH] Documentation: btrfs: remove usage specific information
Date: Fri, 11 Mar 2016 14:06:05 +0800 [thread overview]
Message-ID: <56E2604D.9070505@oracle.com> (raw)
In-Reply-To: <20160310125831.GD18908@twin.jikos.cz>
On 03/10/2016 08:58 PM, David Sterba wrote:
> On Thu, Mar 10, 2016 at 09:17:49AM +0800, Anand Jain wrote:
>>
>>
>> On 03/10/2016 01:11 AM, David Sterba wrote:
>>> On Wed, Mar 09, 2016 at 10:26:51AM +0900, Satoru Takeuchi wrote:
>>>>> +that maintains information about administration tasks, frequently asked
>>>>> +questions, use cases, mount options, comprehensible changelogs, features,
>>>>> +manual pages, source code repositories, contacts etc.
>>>>
>>>> About mount options, we also have "man 5 btrfs" and it's
>>>> newer than wiki page's one.
>>>>
>>>> https://www.mail-archive.com/linux-btrfs%40vger.kernel.org/msg34545.html
>>>> commit 26341f734d6d ("btrfs-progs: add mount options to btrfs-mount.5")
>>>>
>>>> Last update:
>>>> - Btrfs wiki -> Mount options: Sep 19 2015
>>>> - btrfs-man5.asciidoc: Jan 11 2016
>>>
>>> I'm consolidating the documentation to a single source if possible, at
>>> the moment the wiki page for mount option still exists and lags behind
>>> the manual page. Also the wiki page btrfs-mount hasn't been renamed to
>>> btrfs-man5 and the contents.
>>>
>>> The conversion scripts are at https://github.com/kdave/btrfs-wiki
>>> (/git2wiki) . They're not perfect and sometimes produces strange
>>> artifacts, so this is where it gets stuck.
>>>
>>>> So, how about refer to "man 5 btrfs" from
>>>> "Btrfs wiki -> Mount options -> List of options"
>>>> and/or this document?
>>>
>>> I'd prefer to update the wiki.
>>
>> Which one would be the master copy ? So it will determine
>> a process for the steady state production.. either
>> update wiki and then - sync up to -> man or
>> update man and then - sync up to -> wiki
>
> I understand Satoru's question whether we should add the reference to
> manual page into Documentation/filesystems/btrfs.txt or to the wiki, and
> I say to the wiki.
>
> You are asking what's the expected process to update the manual pages.
> There's no change, the source is in btrfs-progs git. After a release,
> the manual pages are converted to wiki markup and uploaded.
>
> The wiki page Mount_option is supposed to stay (and updated manually),
> there are external references to it. Its contents might be updated from
> the manual page sources at some point.
Nice. Thanks for clarifying.
- Anand
prev parent reply other threads:[~2016-03-11 6:06 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-03-08 17:04 [PATCH] Documentation: btrfs: remove usage specific information David Sterba
2016-03-09 1:26 ` Satoru Takeuchi
2016-03-09 17:11 ` David Sterba
2016-03-10 1:17 ` Anand Jain
2016-03-10 12:58 ` David Sterba
2016-03-11 6:06 ` Anand Jain [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=56E2604D.9070505@oracle.com \
--to=anand.jain@oracle.com \
--cc=clm@fb.com \
--cc=dsterba@suse.cz \
--cc=linux-btrfs@vger.kernel.org \
--cc=takeuchi_satoru@jp.fujitsu.com \
/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).