[0/3] man-pages: add documentation for statmount/listmount

Message

Josef Bacik June 25, 2024, 6:56 p.m. UTC

Hello,

We don't have docs for statmount(2) or listmount(2) yet, so here is a first pass
at this.  I've never had to write man pages, and the `make lint` thing doesn't
work because it's looking for checkpatch, but if I put checkpatch.pl in my path
it messes up.

I was able to run make check and fix up a variety of format things, so hopefully
these are usable.

In any case I've added to the statx(2) doc for the new STATX_MNT_ID_UNIQUE that
is needed to utlize any of this.

I've added two man pages, one for statmount(2) and listmount(2).  This reflects
the current state of what is in Linus's tree, it doesn't have any of the
additions Christian and I have done recently, I will fix them up later when
those changes are merged.  Thanks,

Josef

Josef Bacik (3):
  statx.2: Document STATX_MNT_ID_UNIQUE
  statmount.2: New page describing the statmount syscall
  listmount.2: New page describing the listmount syscall

 man/man2/listmount.2 | 107 +++++++++++++++++
 man/man2/statmount.2 | 274 +++++++++++++++++++++++++++++++++++++++++++
 man/man2/statx.2     |  12 +-
 3 files changed, 391 insertions(+), 2 deletions(-)
 create mode 100644 man/man2/listmount.2
 create mode 100644 man/man2/statmount.2

Comments

Alejandro Colomar June 25, 2024, 7:27 p.m. UTC | #1

On Tue, Jun 25, 2024 at 02:56:03PM GMT, Josef Bacik wrote:
> Hello,

Hi Josef,

> We don't have docs for statmount(2) or listmount(2) yet, so here is a first pass
> at this.  I've never had to write man pages, and the `make lint` thing doesn't
> work because it's looking for checkpatch, but if I put checkpatch.pl in my path
> it messes up.

You should be able to `make -t lint-c-checkpatch` to skip those.

> I was able to run make check and fix up a variety of format things, so hopefully
> these are usable.

Great.  I'll help if there are any problems.

> 
> In any case I've added to the statx(2) doc for the new STATX_MNT_ID_UNIQUE that
> is needed to utlize any of this.
> 
> I've added two man pages, one for statmount(2) and listmount(2).  This reflects
> the current state of what is in Linus's tree, it doesn't have any of the
> additions Christian and I have done recently, I will fix them up later when
> those changes are merged.  Thanks,
> 
> Josef

Thanks!

Have a lovely day!
Alex

> 
> Josef Bacik (3):
>   statx.2: Document STATX_MNT_ID_UNIQUE
>   statmount.2: New page describing the statmount syscall
>   listmount.2: New page describing the listmount syscall
> 
>  man/man2/listmount.2 | 107 +++++++++++++++++
>  man/man2/statmount.2 | 274 +++++++++++++++++++++++++++++++++++++++++++
>  man/man2/statx.2     |  12 +-
>  3 files changed, 391 insertions(+), 2 deletions(-)
>  create mode 100644 man/man2/listmount.2
>  create mode 100644 man/man2/statmount.2
> 
> -- 
> 2.43.0
>