Add sub-topic on 'exFAT' in man mount

Add sub-topic on 'exFAT' in man mount

[Seamus de Mora]

I'd like to volunteer to add some information to the mount manual.

I'm told that exFAT was added to the kernel about 4 years ago, but
last I checked, there was nothing about it in man mount.  I feel this
could be addressed best by adding a sub-topic on exFAT under the topic
`FILESYSTEM-SPECIFIC MOUNT OPTIONS`.

If my application is of interest, please let me know what steps I need
to take - or how to approach this task.

Best Rgds,
~S

Re: Add sub-topic on 'exFAT' in man mount

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 850 bytes --]

Hello Seamus,

On Mon, Nov 20, 2023 at 04:55:18PM -0600, Seamus de Mora wrote:
> I'd like to volunteer to add some information to the mount manual.
> 
> I'm told that exFAT was added to the kernel about 4 years ago, but
> last I checked, there was nothing about it in man mount.  I feel this
> could be addressed best by adding a sub-topic on exFAT under the topic
> `FILESYSTEM-SPECIFIC MOUNT OPTIONS`.
> 
> If my application is of interest, please let me know what steps I need
> to take - or how to approach this task.

It is of interest.  Thanks!  :)

You could start by reading the ./CONTRIBUTING file.  If you have any
doubts, feel free to ask more specific questions.  You could also add
something to filesystems(5) about exFAT, BTW.

Cheers,
Alex

> 
> Best Rgds,
> ~S
> 

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[Seamus de Mora]

Uh, OK... stupid question first: Where is ./CONTRIBUTING?

On Mon, Nov 20, 2023 at 5:30 PM Alejandro Colomar <alx@kernel.org> wrote:
>
> Hello Seamus,
>
> On Mon, Nov 20, 2023 at 04:55:18PM -0600, Seamus de Mora wrote:
> > I'd like to volunteer to add some information to the mount manual.
> >
> > I'm told that exFAT was added to the kernel about 4 years ago, but
> > last I checked, there was nothing about it in man mount.  I feel this
> > could be addressed best by adding a sub-topic on exFAT under the topic
> > `FILESYSTEM-SPECIFIC MOUNT OPTIONS`.
> >
> > If my application is of interest, please let me know what steps I need
> > to take - or how to approach this task.
>
> It is of interest.  Thanks!  :)
>
> You could start by reading the ./CONTRIBUTING file.  If you have any
> doubts, feel free to ask more specific questions.  You could also add
> something to filesystems(5) about exFAT, BTW.
>
> Cheers,
> Alex
>
> >
> > Best Rgds,
> > ~S
> >
>
> --
> <https://www.alejandro-colomar.es/>

Re: Add sub-topic on 'exFAT' in man mount

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 398 bytes --]

On Mon, Nov 20, 2023 at 05:44:40PM -0600, Seamus de Mora wrote:
> Uh, OK... stupid question first: Where is ./CONTRIBUTING?
> 

Please don't top-post, reply inline with appropriate context instead.

It is in man-pages.git tree [1].

Thanks.

[1]: https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 1162 bytes --]

Hi Seamus, Bagas,

[I'm reordering to better reply.]

On Tue, Nov 21, 2023 at 01:48:14PM +0700, Bagas Sanjaya wrote:
> Please don't top-post, reply inline with appropriate context instead.

And the mandatory example.  :)

A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
A: Top-posting.
Q: What is the most annoying thing in e-mail?

> On Mon, Nov 20, 2023 at 05:44:40PM -0600, Seamus de Mora wrote:
> > Uh, OK... stupid question first: Where is ./CONTRIBUTING?
> 
> It is in man-pages.git tree [1].
> 
> Thanks.
> 
> [1]: https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING

Yes, it is in the root of the source code repository.  Since you sent
the mail to the correct addresses (alx@ and linux-man@), I assumed you
had read at least the head(1) of that file, since it's the only place I
know that documents that.  I'm now curious: how did you know the
addresses to write to?

Cheers,
Alex

P.S.: Thanks, Bagas, for suggesting documenting in the Linux repo too
      and CCing the relevant list.

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1516 bytes --]

On Tue, Nov 21, 2023 at 11:08:17AM +0100, Alejandro Colomar wrote:
> Hi Seamus, Bagas,
> 
> [I'm reordering to better reply.]
> 
> On Tue, Nov 21, 2023 at 01:48:14PM +0700, Bagas Sanjaya wrote:
> > Please don't top-post, reply inline with appropriate context instead.
> 
> And the mandatory example.  :)
> 
> A: Because it messes up the order in which people normally read text.
> Q: Why is top-posting such a bad thing?
> A: Top-posting.
> Q: What is the most annoying thing in e-mail?

Thanks for the pro tip! I was adapting my above message from broonie [1].

> 
> > On Mon, Nov 20, 2023 at 05:44:40PM -0600, Seamus de Mora wrote:
> > > Uh, OK... stupid question first: Where is ./CONTRIBUTING?
> > 
> > It is in man-pages.git tree [1].
> > 
> > Thanks.
> > 
> > [1]: https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING
> 
> Yes, it is in the root of the source code repository.  Since you sent
> the mail to the correct addresses (alx@ and linux-man@), I assumed you
> had read at least the head(1) of that file, since it's the only place I
> know that documents that.  I'm now curious: how did you know the
> addresses to write to?

Observing the mailing list [2] AND read that file in man-page.git tree.
For the kernel proper, I always look in MAINTAINERS.

Thanks.

[1]: https://lore.kernel.org/all/ZI2jhXUMv9QYmL94@finisterre.sirena.org.uk/
[2]: https://lore.kernel.org/linux-man

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[Alejandro Colomar]

[-- Attachment #1: Type: text/plain, Size: 956 bytes --]

Hi Bagas,

On Tue, Nov 21, 2023 at 06:41:41PM +0700, Bagas Sanjaya wrote:
> > > On Mon, Nov 20, 2023 at 05:44:40PM -0600, Seamus de Mora wrote:
> > > > Uh, OK... stupid question first: Where is ./CONTRIBUTING?
> > > 
> > > It is in man-pages.git tree [1].
> > > 
> > > Thanks.
> > > 
> > > [1]: https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING
> > 
> > Yes, it is in the root of the source code repository.  Since you sent
> > the mail to the correct addresses (alx@ and linux-man@), I assumed you
> > had read at least the head(1) of that file, since it's the only place I
> > know that documents that.  I'm now curious: how did you know the
> > addresses to write to?
> 
> Observing the mailing list [2] AND read that file in man-page.git tree.
> For the kernel proper, I always look in MAINTAINERS.

Ah, no, I was asking that to Seamus.  :)

Cheers,
Alex

-- 
<https://www.alejandro-colomar.es/>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1130 bytes --]

On Tue, Nov 21, 2023 at 01:51:25PM +0100, Alejandro Colomar wrote:
> Hi Bagas,
> 
> On Tue, Nov 21, 2023 at 06:41:41PM +0700, Bagas Sanjaya wrote:
> > > > On Mon, Nov 20, 2023 at 05:44:40PM -0600, Seamus de Mora wrote:
> > > > > Uh, OK... stupid question first: Where is ./CONTRIBUTING?
> > > > 
> > > > It is in man-pages.git tree [1].
> > > > 
> > > > Thanks.
> > > > 
> > > > [1]: https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING
> > > 
> > > Yes, it is in the root of the source code repository.  Since you sent
> > > the mail to the correct addresses (alx@ and linux-man@), I assumed you
> > > had read at least the head(1) of that file, since it's the only place I
> > > know that documents that.  I'm now curious: how did you know the
> > > addresses to write to?
> > 
> > Observing the mailing list [2] AND read that file in man-page.git tree.
> > For the kernel proper, I always look in MAINTAINERS.
> 
> Ah, no, I was asking that to Seamus.  :)

Oops, I thought you were addressing to me. Thanks anyway.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[G. Branden Robinson]

[-- Attachment #1: Type: text/plain, Size: 840 bytes --]

At 2023-11-21T11:08:17+0100, Alejandro Colomar wrote:
> On Tue, Nov 21, 2023 at 01:48:14PM +0700, Bagas Sanjaya wrote:
> > Please don't top-post, reply inline with appropriate context instead.
> 
> And the mandatory example.  :)
> 
> A: Because it messes up the order in which people normally read text.
> Q: Why is top-posting such a bad thing?
> A: Top-posting.
> Q: What is the most annoying thing in e-mail?

In corporate communications it can make sense to top-post (and not
remove any quoted material, no matter how irrelevant).  I won't
elaborate here, because this is not a venue for corporate
communications.  But I have seen some programmers over-apply the above
preference and humor in contexts where there are reasons not to do so.

Only you can stop Dunning-Krugerism in its tracks!  ;-)

Regards,
Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[Seamus de Mora]

> > Uh, OK... stupid question first: Where is ./CONTRIBUTING?
> >
>
> Please don't top-post, reply inline with appropriate context instead.
>
> It is in man-pages.git tree [1].
>
> [1]: https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING
>

Apologies for top-posting... it is indeed a scourge for mail lists
like this - long threads w/ many participants.

I think I need a different mail client... Gmail clearly sucks at this.

Rgds,
~S

Re: Add sub-topic on 'exFAT' in man mount

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 996 bytes --]

On Mon, Nov 20, 2023 at 04:55:18PM -0600, Seamus de Mora wrote:
> I'd like to volunteer to add some information to the mount manual.
> 
> I'm told that exFAT was added to the kernel about 4 years ago, but
> last I checked, there was nothing about it in man mount.  I feel this
> could be addressed best by adding a sub-topic on exFAT under the topic
> `FILESYSTEM-SPECIFIC MOUNT OPTIONS`.
> 
> If my application is of interest, please let me know what steps I need
> to take - or how to approach this task.
> 

I'm adding from Alejandro's reply.

You can start reading the source in fs/exfat in linux.git tree [1].
Then you can write the documentation for exfat in Documentation/exfat.rst
(currently doesn't exist yet), at the same time of your manpage contribution.

Cc'ing exfat maintainers for better treatment.

Thanks.

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/fs/exfat

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: Add sub-topic on 'exFAT' in man mount

[Namjae Jeon]

2023-11-21 15:55 GMT+09:00, Bagas Sanjaya <bagasdotme@gmail.com>:
> On Mon, Nov 20, 2023 at 04:55:18PM -0600, Seamus de Mora wrote:
>> I'd like to volunteer to add some information to the mount manual.
>>
>> I'm told that exFAT was added to the kernel about 4 years ago, but
>> last I checked, there was nothing about it in man mount.  I feel this
>> could be addressed best by adding a sub-topic on exFAT under the topic
>> `FILESYSTEM-SPECIFIC MOUNT OPTIONS`.
>>
>> If my application is of interest, please let me know what steps I need
>> to take - or how to approach this task.
>>
>
> I'm adding from Alejandro's reply.
>
> You can start reading the source in fs/exfat in linux.git tree [1].
> Then you can write the documentation for exfat in Documentation/exfat.rst
> (currently doesn't exist yet), at the same time of your manpage
> contribution.
>
> Cc'ing exfat maintainers for better treatment.
Thanks Bagas for forwarding this to us!

Hi Seamus,

Some of mount options are same with fatfs's ones. You can refer the
descriptions of fatfs
documentation(Documentation/filesystems/vfat.rst).
If you have any questions about other options or documentation for
exfat, please give an email me.

Thanks!
>
> Thanks.
>
> [1]:
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/fs/exfat
>
> --
> An old man doll... just what I always wanted! - Clara
>

Re: Add sub-topic on 'exFAT' in man mount

[Seamus de Mora]

On Sun, Nov 26, 2023 at 5:59 PM Namjae Jeon <linkinjeon@kernel.org> wrote:
>
> 2023-11-21 15:55 GMT+09:00, Bagas Sanjaya <bagasdotme@gmail.com>:
> > On Mon, Nov 20, 2023 at 04:55:18PM -0600, Seamus de Mora wrote:
> >> I'd like to volunteer to add some information to the mount manual.
> >>
> >> I'm told that exFAT was added to the kernel about 4 years ago, but
> >> last I checked, there was nothing about it in man mount.  I feel this
> >> could be addressed best by adding a sub-topic on exFAT under the topic
> >> `FILESYSTEM-SPECIFIC MOUNT OPTIONS`.
> >>
> >> If my application is of interest, please let me know what steps I need
> >> to take - or how to approach this task.
> >>
> >
> > I'm adding from Alejandro's reply.
> >
> > You can start reading the source in fs/exfat in linux.git tree [1].
> > Then you can write the documentation for exfat in Documentation/exfat.rst
> > (currently doesn't exist yet), at the same time of your manpage
> > contribution.
> >
> > Cc'ing exfat maintainers for better treatment.
> Thanks Bagas for forwarding this to us!
>
> Hi Seamus,
>
> Some of mount options are same with fatfs's ones. You can refer the
> descriptions of fatfs
> documentation(Documentation/filesystems/vfat.rst).
> If you have any questions about other options or documentation for
> exfat, please give an email me.
>
> Thanks!
> >
> > Thanks.
> >
> > [1]:
> > https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/fs/exfat

Thanks for the offer Namjae; I'm sure I'll take you up on that when I
get ready to actually produce something. For now, I am reading and
trying to get myself up to speed to tackle this. So far, the going has
been a bit slow as I have a couple of commitments I need to finish.

Rgds,
~S

Re: Add sub-topic on 'exFAT' in man mount

[Seamus de Mora]

On Mon, Nov 27, 2023 at 4:43 PM Seamus de Mora <seamusdemora@gmail.com> wrote:
>
> On Sun, Nov 26, 2023 at 5:59 PM Namjae Jeon <linkinjeon@kernel.org> wrote:
> >
> > 2023-11-21 15:55 GMT+09:00, Bagas Sanjaya <bagasdotme@gmail.com>:
> > > On Mon, Nov 20, 2023 at 04:55:18PM -0600, Seamus de Mora wrote:
> > >> I'd like to volunteer to add some information to the mount manual.
> > >>
> > >> I'm told that exFAT was added to the kernel about 4 years ago, but
> > >> last I checked, there was nothing about it in man mount.  I feel this
> > >> could be addressed best by adding a sub-topic on exFAT under the topic
> > >> `FILESYSTEM-SPECIFIC MOUNT OPTIONS`.
> > >>
> > >> If my application is of interest, please let me know what steps I need
> > >> to take - or how to approach this task.
> > >>
> > >
> > > I'm adding from Alejandro's reply.
> > >
> > > You can start reading the source in fs/exfat in linux.git tree [1].
> > > Then you can write the documentation for exfat in Documentation/exfat.rst
> > > (currently doesn't exist yet), at the same time of your manpage
> > > contribution.
> > >
> > > Cc'ing exfat maintainers for better treatment.
> > Thanks Bagas for forwarding this to us!
> >
> > Hi Seamus,
> >
> > Some of mount options are same with fatfs's ones. You can refer the
> > descriptions of fatfs
> > documentation(Documentation/filesystems/vfat.rst).
> > If you have any questions about other options or documentation for
> > exfat, please give an email me.
> >
> > Thanks!
> > >
> > > Thanks.
> > >
> > > [1]:
> > > https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/fs/exfat
>
> Thanks for the offer Namjae; I'm sure I'll take you up on that when I
> get ready to actually produce something. For now, I am reading and
> trying to get myself up to speed to tackle this. So far, the going has
> been a bit slow as I have a couple of commitments I need to finish.

I've read a bit about the mechanics & markup for creating/editing man
pages. Now all I need is something useful to say :)

In that regard, I **guess** the best place to look for the details I
need is in the source code. Without access to the author or
maintainers, I don't see how else to get at the details needed for a
decent piece of documentation. I think that is what Bagas (?)
suggested, but how/where do I find "fs/exfat in linux.git tree" ??

Thanks,
~S

Re: Add sub-topic on 'exFAT' in man mount

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 3038 bytes --]

On Tue, Dec 05, 2023 at 01:49:42AM -0600, Seamus de Mora wrote:
> On Mon, Nov 27, 2023 at 4:43 PM Seamus de Mora <seamusdemora@gmail.com> wrote:
> >
> > On Sun, Nov 26, 2023 at 5:59 PM Namjae Jeon <linkinjeon@kernel.org> wrote:
> > >
> > > 2023-11-21 15:55 GMT+09:00, Bagas Sanjaya <bagasdotme@gmail.com>:
> > > > On Mon, Nov 20, 2023 at 04:55:18PM -0600, Seamus de Mora wrote:
> > > >> I'd like to volunteer to add some information to the mount manual.
> > > >>
> > > >> I'm told that exFAT was added to the kernel about 4 years ago, but
> > > >> last I checked, there was nothing about it in man mount.  I feel this
> > > >> could be addressed best by adding a sub-topic on exFAT under the topic
> > > >> `FILESYSTEM-SPECIFIC MOUNT OPTIONS`.
> > > >>
> > > >> If my application is of interest, please let me know what steps I need
> > > >> to take - or how to approach this task.
> > > >>
> > > >
> > > > I'm adding from Alejandro's reply.
> > > >
> > > > You can start reading the source in fs/exfat in linux.git tree [1].
> > > > Then you can write the documentation for exfat in Documentation/exfat.rst
> > > > (currently doesn't exist yet), at the same time of your manpage
> > > > contribution.
> > > >
> > > > Cc'ing exfat maintainers for better treatment.
> > > Thanks Bagas for forwarding this to us!
> > >
> > > Hi Seamus,
> > >
> > > Some of mount options are same with fatfs's ones. You can refer the
> > > descriptions of fatfs
> > > documentation(Documentation/filesystems/vfat.rst).
> > > If you have any questions about other options or documentation for
> > > exfat, please give an email me.
> > >
> > > Thanks!
> > > >
> > > > Thanks.
> > > >
> > > > [1]:
> > > > https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/fs/exfat
> >
> > Thanks for the offer Namjae; I'm sure I'll take you up on that when I
> > get ready to actually produce something. For now, I am reading and
> > trying to get myself up to speed to tackle this. So far, the going has
> > been a bit slow as I have a couple of commitments I need to finish.
> 
> I've read a bit about the mechanics & markup for creating/editing man
> pages. Now all I need is something useful to say :)
> 
> In that regard, I **guess** the best place to look for the details I
> need is in the source code. Without access to the author or
> maintainers, I don't see how else to get at the details needed for a
> decent piece of documentation. I think that is what Bagas (?)
> suggested, but how/where do I find "fs/exfat in linux.git tree" ??

That's simple. First, you need to clone Linus's tree:

```
$ git clone https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git linux-kernel
$ cd linux-kernel/
```

You can now browse exfat sources in fs/exfat.

To get maintainers list that you should Cc: when submitting patches, do
from cloned repo:

```
$ scripts/get_maintainer.pl fs/exfat/
```

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]