Re: [Linuxptp-devel] [PATCH 0/6] man pages: Spring Cleaning

2023-02-17 Thread Richard Cochran
On Thu, Feb 16, 2023 at 08:10:20PM -0800, Richard Cochran wrote:
> Early on, around v1, there were about thirty configuration options,
> and these were grouped into functional areas in the man page.  At the
> time, that made some kind of sense.
> 
> Nowadays, the number of configuration options has grown to nearly 100,
> and, as a result, the ordering within the ptp4l man page is chaotic at
> best.  With so many options, the only sane ordering is alphabetical.
> 
> When alphabetizing, I did a sanity check that the context wasn't
> changed by doing:

s/context/content/

>sort ptp4l.8 > before
>(hack)
>sort ptp4l.8 > after
>diff -u before after

Thanks,
Richard


___
Linuxptp-devel mailing list
Linuxptp-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linuxptp-devel


[Linuxptp-devel] [PATCH 0/6] man pages: Spring Cleaning

2023-02-16 Thread Richard Cochran
Early on, around v1, there were about thirty configuration options,
and these were grouped into functional areas in the man page.  At the
time, that made some kind of sense.

Nowadays, the number of configuration options has grown to nearly 100,
and, as a result, the ordering within the ptp4l man page is chaotic at
best.  With so many options, the only sane ordering is alphabetical.

When alphabetizing, I did a sanity check that the context wasn't
changed by doing:

   sort ptp4l.8 > before
   (hack)
   sort ptp4l.8 > after
   diff -u before after


Richard Cochran (6):
  Alphabetize configuration options in the ptp4l man page.
  Remove stray copy/pasteo from the phc2sys man page.
  Alphabetize configuration options in the phc2sys man page.
  Alphabetize configuration options in the pmc man page.
  Alphabetize configuration options in the ts2phc man page.
  man pages: Bump date.

 phc2sys.8 |  129 +++---
 pmc.8 |   10 +-
 ptp4l.8   | 1127 +
 ts2phc.8  |   35 +-
 4 files changed, 710 insertions(+), 591 deletions(-)

-- 
2.30.2



___
Linuxptp-devel mailing list
Linuxptp-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/linuxptp-devel