Linux CIFS filesystem development
 help / color / mirror / Atom feed
* mount.cifs man page
@ 2022-08-18 16:20 Steve French
  2022-08-18 16:30 ` Enzo Matsumiya
  0 siblings, 1 reply; 3+ messages in thread
From: Steve French @ 2022-08-18 16:20 UTC (permalink / raw)
  To: CIFS

I was looking at the mount.cifs man page, which is missing
documentation for some mount options, and also could be made less
confusing by moving some of the less commonly needed mount options.

Are there good examples (of better written man pages) that we could
borrow ideas for a a breakdown by section, etc. ?

-- 
Thanks,

Steve

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: mount.cifs man page
  2022-08-18 16:20 mount.cifs man page Steve French
@ 2022-08-18 16:30 ` Enzo Matsumiya
  2022-08-18 17:48   ` Tom Talpey
  0 siblings, 1 reply; 3+ messages in thread
From: Enzo Matsumiya @ 2022-08-18 16:30 UTC (permalink / raw)
  To: Steve French; +Cc: CIFS

On 08/18, Steve French wrote:
>I was looking at the mount.cifs man page, which is missing
>documentation for some mount options, and also could be made less
>confusing by moving some of the less commonly needed mount options.
>
>Are there good examples (of better written man pages) that we could
>borrow ideas for a a breakdown by section, etc. ?

I keep referring to nvme stuff, whether it's code or documentation. I
think they do a pretty good job in making things clear.

cf.: man 1 nvme, (e.g.) man 1 nvme-connect, drivers/nvme/*

HTH

>-- 
>Thanks,
>
>Steve

Cheers,

Enzo

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: mount.cifs man page
  2022-08-18 16:30 ` Enzo Matsumiya
@ 2022-08-18 17:48   ` Tom Talpey
  0 siblings, 0 replies; 3+ messages in thread
From: Tom Talpey @ 2022-08-18 17:48 UTC (permalink / raw)
  To: Enzo Matsumiya, Steve French; +Cc: CIFS

On 8/18/2022 12:30 PM, Enzo Matsumiya wrote:
> On 08/18, Steve French wrote:
>> I was looking at the mount.cifs man page, which is missing
>> documentation for some mount options, and also could be made less
>> confusing by moving some of the less commonly needed mount options.

"Some" mount options?!? I counted at least 100 when I last looked
at fs_context.c ...

That said, don't let me deter you! It's a good plan.

Tom.

>> Are there good examples (of better written man pages) that we could
>> borrow ideas for a a breakdown by section, etc. ?
> 
> I keep referring to nvme stuff, whether it's code or documentation. I
> think they do a pretty good job in making things clear.
> 
> cf.: man 1 nvme, (e.g.) man 1 nvme-connect, drivers/nvme/*
> 
> HTH
> 
>> -- 
>> Thanks,
>>
>> Steve
> 
> Cheers,
> 
> Enzo
> 

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2022-08-18 17:48 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-08-18 16:20 mount.cifs man page Steve French
2022-08-18 16:30 ` Enzo Matsumiya
2022-08-18 17:48   ` Tom Talpey

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox