mbox series

[v2,0/2] man-pages: add documentation for statmount/listmount

Message ID cover.1719417184.git.josef@toxicpanda.com (mailing list archive)
Headers show
Series man-pages: add documentation for statmount/listmount | expand

Message

Josef Bacik June 26, 2024, 3:56 p.m. UTC
V1: https://lore.kernel.org/linux-fsdevel/cover.1719341580.git.josef@toxicpanda.com/

v1->v2:
- Dropped the statx patch as Alejandro already took it (thanks!)
- Reworked everything to use semantic newlines
- Addressed all of the comments on the statmount.2 man page

I'm still unable to run anything other than make check, and if I do `make -t
lint-c-checkpatch` and then run make check lint build it fails almost
immediately on other unrelated things, so I think I'm too dumb to know how to
check these patches before I send them.  However I did my best to follow all of
the suggestions.  Thanks,

Josef

Josef Bacik (2):
  statmount.2: New page describing the statmount syscall
  listmount.2: New page describing the listmount syscall

 man/man2/listmount.2 | 114 +++++++++++++++++
 man/man2/statmount.2 | 289 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 403 insertions(+)
 create mode 100644 man/man2/listmount.2
 create mode 100644 man/man2/statmount.2

Comments

Alejandro Colomar June 26, 2024, 5:02 p.m. UTC | #1
Hi Josef,

On Wed, Jun 26, 2024 at 11:56:06AM GMT, Josef Bacik wrote:
> V1: https://lore.kernel.org/linux-fsdevel/cover.1719341580.git.josef@toxicpanda.com/
> 
> v1->v2:
> - Dropped the statx patch as Alejandro already took it (thanks!)
> - Reworked everything to use semantic newlines
> - Addressed all of the comments on the statmount.2 man page
> 
> I'm still unable to run anything other than make check, and if I do `make -t
> lint-c-checkpatch` and then run make check lint build it fails almost
> immediately on other unrelated things, so I think I'm too dumb to know how to
> check these patches before I send them.  However I did my best to follow all of
> the suggestions.  Thanks,

I'm interested in learning what problems contributors face, so please
let me know those issues, if you don't mind.

You can

	$ make lint build check -j8 -k
	$ make lint build check

to see the full list of failures.

Have a lovely day!
Alex

> 
> Josef
> 
> Josef Bacik (2):
>   statmount.2: New page describing the statmount syscall
>   listmount.2: New page describing the listmount syscall
> 
>  man/man2/listmount.2 | 114 +++++++++++++++++
>  man/man2/statmount.2 | 289 +++++++++++++++++++++++++++++++++++++++++++
>  2 files changed, 403 insertions(+)
>  create mode 100644 man/man2/listmount.2
>  create mode 100644 man/man2/statmount.2
> 
> -- 
> 2.43.0
> 
>
Josef Bacik June 26, 2024, 6:04 p.m. UTC | #2
On Wed, Jun 26, 2024 at 07:02:26PM +0200, Alejandro Colomar wrote:
> Hi Josef,
> 
> On Wed, Jun 26, 2024 at 11:56:06AM GMT, Josef Bacik wrote:
> > V1: https://lore.kernel.org/linux-fsdevel/cover.1719341580.git.josef@toxicpanda.com/
> > 
> > v1->v2:
> > - Dropped the statx patch as Alejandro already took it (thanks!)
> > - Reworked everything to use semantic newlines
> > - Addressed all of the comments on the statmount.2 man page
> > 
> > I'm still unable to run anything other than make check, and if I do `make -t
> > lint-c-checkpatch` and then run make check lint build it fails almost
> > immediately on other unrelated things, so I think I'm too dumb to know how to
> > check these patches before I send them.  However I did my best to follow all of
> > the suggestions.  Thanks,
> 
> I'm interested in learning what problems contributors face, so please
> let me know those issues, if you don't mind.
> 
> You can
> 
> 	$ make lint build check -j8 -k
> 	$ make lint build check
> 
> to see the full list of failures.

I captured the output of

make lint build check -j8 -k > out.txt 2>&1

and pasted it here

https://paste.centos.org/view/ed3387a9

Clang messes up a bunch for a variety of different pages.

Also I did hit some mandoc warnings on this series, I'll post a v3 in a moment
with those things fixed.  Thanks,

Josef
Alejandro Colomar June 26, 2024, 6:41 p.m. UTC | #3
Hi Josef,

On Wed, Jun 26, 2024 at 02:04:34PM GMT, Josef Bacik wrote:
> On Wed, Jun 26, 2024 at 07:02:26PM +0200, Alejandro Colomar wrote:
> > You can
> > 
> > 	$ make lint build check -j8 -k
> > 	$ make lint build check
> > 
> > to see the full list of failures.
> 
> I captured the output of
> 
> make lint build check -j8 -k > out.txt 2>&1

Hmmm, please do the following steps to have a cleaner log:

	## Let's see if the build system itself complains:
	$ make nothing >out0.txt

	## Skip checkpatch stuff:
	$ make -t lint-c-checkpatch

	## Make fast stuff that doesn't break:
	$ make lint build check -j8 -k >/dev/null 2>/dev/null

	## Now log the remaining errors:
	$ make lint build check >out.txt 2>&1

> and pasted it here
> 
> https://paste.centos.org/view/ed3387a9

BTW, you seem to also be missing cppcheck(1), which at least in Debian
is provided in the cppcheck package.  It also seems to be available in
Fedora, but I don't know if your system will have it.

> Clang messes up a bunch for a variety of different pages.

I suspect the Clang errors to be due to missing libbsd-dev.

> Also I did hit some mandoc warnings on this series, I'll post a v3 in a moment
> with those things fixed.  Thanks,

Thank you!

Have a lovely day!
Alex

> 
> Josef
Josef Bacik June 26, 2024, 9:44 p.m. UTC | #4
On Wed, Jun 26, 2024 at 08:41:06PM +0200, Alejandro Colomar wrote:
> Hi Josef,
> 
> On Wed, Jun 26, 2024 at 02:04:34PM GMT, Josef Bacik wrote:
> > On Wed, Jun 26, 2024 at 07:02:26PM +0200, Alejandro Colomar wrote:
> > > You can
> > > 
> > > 	$ make lint build check -j8 -k
> > > 	$ make lint build check
> > > 
> > > to see the full list of failures.
> > 
> > I captured the output of
> > 
> > make lint build check -j8 -k > out.txt 2>&1
> 
> Hmmm, please do the following steps to have a cleaner log:
> 
> 	## Let's see if the build system itself complains:
> 	$ make nothing >out0.txt
> 
> 	## Skip checkpatch stuff:
> 	$ make -t lint-c-checkpatch
> 
> 	## Make fast stuff that doesn't break:
> 	$ make lint build check -j8 -k >/dev/null 2>/dev/null
> 
> 	## Now log the remaining errors:
> 	$ make lint build check >out.txt 2>&1
> 
> > and pasted it here
> > 
> > https://paste.centos.org/view/ed3387a9
> 
> BTW, you seem to also be missing cppcheck(1), which at least in Debian
> is provided in the cppcheck package.  It also seems to be available in
> Fedora, but I don't know if your system will have it.
> 
> > Clang messes up a bunch for a variety of different pages.
> 
> I suspect the Clang errors to be due to missing libbsd-dev.
> 

Ok well those two things fixed most of the errors, now I'm down to just this

https://paste.centos.org/view/acd71eb7

I'm on Fedora btw. Thanks,

Josef
Josef Bacik June 26, 2024, 9:50 p.m. UTC | #5
On Wed, Jun 26, 2024 at 05:44:07PM -0400, Josef Bacik wrote:
> On Wed, Jun 26, 2024 at 08:41:06PM +0200, Alejandro Colomar wrote:
> > Hi Josef,
> > 
> > On Wed, Jun 26, 2024 at 02:04:34PM GMT, Josef Bacik wrote:
> > > On Wed, Jun 26, 2024 at 07:02:26PM +0200, Alejandro Colomar wrote:
> > > > You can
> > > > 
> > > > 	$ make lint build check -j8 -k
> > > > 	$ make lint build check
> > > > 
> > > > to see the full list of failures.
> > > 
> > > I captured the output of
> > > 
> > > make lint build check -j8 -k > out.txt 2>&1
> > 
> > Hmmm, please do the following steps to have a cleaner log:
> > 
> > 	## Let's see if the build system itself complains:
> > 	$ make nothing >out0.txt
> > 
> > 	## Skip checkpatch stuff:
> > 	$ make -t lint-c-checkpatch
> > 
> > 	## Make fast stuff that doesn't break:
> > 	$ make lint build check -j8 -k >/dev/null 2>/dev/null
> > 
> > 	## Now log the remaining errors:
> > 	$ make lint build check >out.txt 2>&1
> > 
> > > and pasted it here
> > > 
> > > https://paste.centos.org/view/ed3387a9
> > 
> > BTW, you seem to also be missing cppcheck(1), which at least in Debian
> > is provided in the cppcheck package.  It also seems to be available in
> > Fedora, but I don't know if your system will have it.
> > 
> > > Clang messes up a bunch for a variety of different pages.
> > 
> > I suspect the Clang errors to be due to missing libbsd-dev.
> > 
> 
> Ok well those two things fixed most of the errors, now I'm down to just this
> 
> https://paste.centos.org/view/acd71eb7
> 

Err that just shows the one error, this is all of them

https://paste.centos.org/view/b68c2fb1

Thanks,

Josef
Alejandro Colomar June 26, 2024, 9:58 p.m. UTC | #6
Hi Josef,

On Wed, Jun 26, 2024 at 05:44:07PM GMT, Josef Bacik wrote:
> 
> Ok well those two things fixed most of the errors, now I'm down to just this
> 
> https://paste.centos.org/view/acd71eb7
> 

Nice; there seems to only be one error:

CLANG_TIDY      .tmp/man/man2/bind.2.d/bind.c.lint-c.clang-tidy.touch

I guess you have a newer version of clang-tidy(1).  I have

	$ clang-tidy --version
	Debian LLVM version 16.0.6
	  Optimized build.

You probably have 18 (or maybe 17).  I guess we'll get there more
eventually in Debian.

I don't see why it fails, so I'll have to wait for reproducing it.

> I'm on Fedora btw. Thanks,

Thank you!

Have a lovely night!
Alex

> 
> Josef
>
Alejandro Colomar June 26, 2024, 10:02 p.m. UTC | #7
On Wed, Jun 26, 2024 at 05:50:34PM GMT, Josef Bacik wrote:
> Err that just shows the one error, this is all of them
> 
> https://paste.centos.org/view/b68c2fb1

For skipping the cpplint(1) errors (I don't see cpplint(1) being
packaged for Fedora according to <pkgs.org>), you can do something
like with checkpatch:

	$ make -t lint-c-cpplint

Cheers,
Alex
Alejandro Colomar June 26, 2024, 10:06 p.m. UTC | #8
On Thu, Jun 27, 2024 at 12:02:07AM GMT, Alejandro Colomar wrote:
> On Wed, Jun 26, 2024 at 05:50:34PM GMT, Josef Bacik wrote:
> > Err that just shows the one error, this is all of them
> > 
> > https://paste.centos.org/view/b68c2fb1
> 
> For skipping the cpplint(1) errors (I don't see cpplint(1) being
> packaged for Fedora according to <pkgs.org>), you can do something
> like with checkpatch:
> 
> 	$ make -t lint-c-cpplint

Ahh, now I see why those clang-diagnostic-empty-translation-unit errors.
The above trick is creating empty translation units.

So, you'll need to do the following steps:

	$ make clean
	$ make -j8 -k lint build check >/dev/null 2>/dev/null
	$ make -t lint-c-checkpatch lint-c-cpplint
	$ make -k lint build check >out.txt 2>&1

This makes sure that you only touch those files that can't be created
otherwise, and not some other intermediate files.

Cheers
Alex