freebsd-src icon indicating copy to clipboard operation
freebsd-src copied to clipboard

intro.2: mention syscalls.h, cleaning

Open concussious opened this issue 1 year ago • 5 comments

i hope it's very nice if the introduction to system calls references the table of system calls.

While we're here:

  • Tag SPDX
  • zap depreciated macros
  • use macros for parenthesis
  • Restructure headings according to mdoc(7) by moving return values to errors.
  • Tweak grammar for consistency
  • Rewrite introductory paragraph of description to integrate with these changes, and read a little more like intro(1).

Description could use a definition for system calls, but I wasn't able to come up with any prose I liked.

concussious avatar Jan 16 '24 22:01 concussious

This needs to be multiple commits not as one big change. With all the reorganization it's impossible to review.

brooksdavis avatar Jan 17 '24 00:01 brooksdavis

Section ii of the man page was there in 1st edition research.

bsdimp avatar Jan 18 '24 01:01 bsdimp

Section ii of the man page was there in 1st edition research.

Sorry, I was intending to say that the introduction to section ii was first introduced in 5th edition research.

concussious avatar Jan 18 '24 16:01 concussious

  • intro.2: mention syscalls.h, cleaning -- adding syscalls.h should be it's own commit.

Fixed, thank you

  • intro.2: RETURN VALUES > ERRORS -- the default GitHub diff behaves very badly with this change. Its there anything other than swapping RETURN VALUES and DEFINITIONS and renaming the former?

That commit should only be that. mdoc(7) says that ERRORS goes after FILES and before SEE ALSO, so that is why I requested to move it.

Thank you for review.

concussious avatar Mar 05 '24 23:03 concussious

Sorry for late noise, I realized how to hopefully improve the introductory paragraph. I also realized the first invocation of errno could use the variable macro like the others. And then I caught a typo.

concussious avatar Mar 06 '24 02:03 concussious

Sorry to churn, only change (should be) first commit redone to use language suggested in https://github.com/freebsd/freebsd-src/pull/1136#discussion_r1518929469 for history section.

EDIT: and bumped docdate since, it's changed.

concussious avatar Mar 22 '24 19:03 concussious

landed

bsdimp avatar Apr 19 '24 22:04 bsdimp