[patch #9585] find.1: Some cleaning of the manual

[Bernhard Voelker]

Update of patch #9585 (project findutils):

 Open/Closed:Open => Closed 


___

Reply to this item at:

  

___
  Message sent via/by Savannah
  http://savannah.gnu.org/

[patch #9585] find.1: Some cleaning of the manual

[Bernhard Voelker]

Follow-up Comment #4, patch #9585 (project findutils):

Thanks.  Pushed at:
https://git.sv.gnu.org/cgit/findutils.git/commit/?id=a0fada430a

___

Reply to this item at:

  

___
  Message sent via/by Savannah
  http://savannah.gnu.org/

[patch #9585] find.1: Some cleaning of the manual

[Bjarni Ingi Gislason]

Follow-up Comment #3, patch #9585 (project findutils):

  "test-groff" is a script created when "groff" is compiled.  Only used
when one does not install it.  It has additions from me that have not
been committed.

  The rest is from a shell script that I have written and extend when I
see something not covered yet.

  All the changes are made manually.  Some "positive" tests are not reported.

  I checked the patch.  My script shows only one deviation; in the line
"Usage: find ...", \& is missing.  That could already have been fixed.

___

Reply to this item at:

  

___
  Message sent via/by Savannah
  http://savannah.gnu.org/

[patch #9585] find.1: Some cleaning of the manual

[Bernhard Voelker]

Follow-up Comment #2, patch #9585 (project findutils):

I wrapped your patch into the attached Git patch.
One hunk was not necessary anymore, because that was already
changed in latest Git.
Please check.

I'd like to also mention which tool you used.  Would you please tell us?

Thanks & have a nice day,
Berny

___

Reply to this item at:

  

___
  Message sent via/by Savannah
  http://savannah.gnu.org/

[patch #9585] find.1: Some cleaning of the manual

[Bernhard Voelker]

Additional Item Attachment, patch #9585 (project findutils):

File name: 0001-doc-fix-various-syntax-issues-in-find.1.patch.gz Size:10 KB


___

Reply to this item at:

  

___
  Message sent via/by Savannah
  http://savannah.gnu.org/

[patch #9585] find.1: Some cleaning of the manual

[Bernhard Voelker]

Update of patch #9585 (project findutils):

 Assigned to:None => berny  

___

Follow-up Comment #1:

wow, that's an impressive list, thanks!

It seems my distribution and web search tool of choice doesn't
know 'test-groff', so how did you get that list?

It also seems to me that some changes have been done by a tool,
e.g. replacing ".   " (3 blanks after a dot) by a newline.
Did you use a tool, and if yes, which one?

It might be interesting to add such checks as a new rule
to 'make syntax-check'.

Now, I'll work on creating a nice - yet not too excessive - commit
message for this.

Thanks & have a nice day,
Berny


___

Reply to this item at:

  

___
  Message sent via/by Savannah
  http://savannah.gnu.org/

[patch #9585] find.1: Some cleaning of the manual

[Bjarni Ingi Gislason]

URL:
  <http://savannah.gnu.org/patch/?9585>

 Summary: find.1: Some cleaning of the manual
 Project: findutils
Submitted by: bjarniig
Submitted on: Sat 10 Mar 2018 11:20:58 PM UTC
Category: documentation improvement
Priority: 3 - Low
  Status: None
 Privacy: Public
 Assigned to: None
 Originator Name: 
Originator Email: 
 Open/Closed: Open
 Discussion Lock: Any
 Release: None
   Fixed Release: None

___

Details:

  The patch is in the attachment

Input file is find.1

Test nr. 2:

Enable and fix warnings from 'test-groff'.
Input file is /tmp/find.1

:922 (macro BR): only 1 argument, but more are expected
:1717 (macro BR): only 1 argument, but more are expected
:1806 (macro BR): only 1 argument, but more are expected
:1832 (macro BR): only 1 argument, but more are expected

chk_manuals: Output is from: test-groff -Tutf8 -b -e -mandoc -rF0 -t -w w -z 



Test nr. 7:

Change (or include a "FIXME" paragraph about) misused SI (metric)
numeric prefixes (or names) to the binary ones, like Ki (kibi), Mi
(mebi), Gi (gibi), or Ti (tebi), if indicated.
If the metric prefixes are correct, add the definitions or an explanation
to avoid misunderstanding.

1194:The block counts are of 1K blocks, unless the environment variable
1411:The amount of disk space used for this file in 1K blocks.  Since disk
space is

#

Test nr. 8:

Protect a full stop (.) with "\&", if it has a blank (white-space) in front
of or (ignoring transparent characters to the full stop) after it, and it
does
not mean an end of a sentence.

6:[\-H] [\-L] [\-P] [\-D debugopts] [\-Olevel] [starting-point...]
[expression]
2231:Usage: find [\-H] [\-L] [\-P] [\-Olevel] [\-D ... [path...] [expression]

#

Test nr. 15:

Change the name of a macro for two fonts (e.g., BR and IR) to one letter,
if there is only one argument.
Add the second argument if needed.  It is sometimes part of the first one.

922:.BR "\-size \-1M"
1717:.BR \-user
1806:.BR \-ok;
1832:.BR \-ok

#

Test nr. 20:

Use a macro to change to the italic font, instead of \fI [1], if
possible.
The macros have the italic corrections, but "\c" removes them.
There only changes are made where the macro ".IR" is of benefit.

[1] man-pages(7)


578:File was last accessed \fIn\fR*24 hours ago.
600:File's status was last changed \fIn\fR*24 hours ago.
630:File is on a filesystem of type \fItype\fR.  The valid filesystem
638:File's numeric group ID is \fIn\fR.
664:File has inode number \fIn\fR.  It is normally easier to use the
699:File's data was last modified \fIn\fR*24 hours ago.
707:matches shell pattern \fIpattern\fR.  Because the leading directories
732:File was modified more recently than \fIfile\fR.  If \fIfile\fR is a
742:than timestamp \fIY\fR of the file \fIreference\fR.   The letters
784:File name matches shell pattern \fIpattern\fR.  The metacharacters do
877:File name matches regular expression \fIpattern\fR.  This is a match
888:File refers to the same inode as \fIname\fR.   When
931:File is of type \fIc\fR:
962:File's numeric user ID is \fIn\fR.
995:link to a file of type \fIc\fR; if the
1004:(SELinux only) Security context of the file matches glob \fIpattern\fR.
1046:Execute \fIcommand\fR; true if 0 status is returned.  All following
1160:True; print the full file name into file \fIfile\fR.  If \fIfile\fR
1301:File's last access time in the format specified by \fIk\fR, which is
1386:File's last status change time in the format specified by \fIk\fR,
1451:File's last modification time in the format specified by \fIk\fR,
1540:Same as ! \fIexpr\fR, but not POSIX compliant.
1549:Same as \fIexpr1 expr2\fR.
1552:Same as \fIexpr1 expr2\fR, but not POSIX compliant.
1565:of \fIexpr2\fR.  The comma operator can be useful for searching for

#

Test nr. 22:

Remove space in the first column,
if not intented.

490: means only apply the tests and actions to the starting-points
themselves.

#

Test nr. 23:

Move a full stop (period) and a comma outside of a quoted text, if it is
at the end of the quote and does not end a quoted sentence.

20:`.' is assumed.
514:hard links: its name and its `.'  entry.  Additionally, its
687:\fIpattern\fR.  The metacharacters do not treat `/' or `.' specially.
716:and `[]') match a `.' at the start of the base name (this is a change
785:not treat `/' or `.' specially; so, for example,
879:`./fubar3', you can use the regular expression `.*bar.' or `.*b.*3',

#

Test nr. 24:


Change a HYPHEN-MINUS (code 0x55, 2D) to a minus (\-), if in front of a
name for an option.

423:.B -regextype
534:.BR -samefile ,
1956:.B find /sbin /usr/sbin -executable \e! -readable \-print
2075:.B find repo/ \e( -exec test -d \(aq{}\(aq/.svn \e; -or \e
2076:.B -e