After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 604574 - Wrong NAME section in docs/nautilus-connect-server.1
Wrong NAME section in docs/nautilus-connect-server.1
Status: RESOLVED FIXED
Product: nautilus
Classification: Core
Component: Documentation
0.x.x [obsolete]
Other Linux
: Normal normal
: ---
Assigned To: Maintainers of Gnome user documentation
Nautilus Maintainers
Depends on:
Blocks:
 
 
Reported: 2009-12-14 19:34 UTC by Emilio Pozuelo Monfort
Modified: 2009-12-15 10:19 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
Fix NAME section (580 bytes, patch)
2009-12-14 19:35 UTC, Emilio Pozuelo Monfort
accepted-commit_now Details | Review

Description Emilio Pozuelo Monfort 2009-12-14 19:34:35 UTC
Hi,

nautilus-connect-server.1 has this NAME section:

.SH NAME
Nautilus Connect Server \- To Access a remote server

However this format is not correct. The part before the escaped dash should be the command name (nautilus-connect-server). From man(7):

       The only mandatory heading is NAME, which should be the  first  section
       and  be followed on the next line by a one line description of the pro‐
       gram:

              .SH NAME

       It is extremely important that this format is followed, and that  there
       is  a  backslash before the single dash which follows the command name.
       This syntax is used by the makewhatis(8) program to create  a  database
       of  short  command  descriptions  for the whatis(1) and apropos(1) com‐
       mands.

The attached patch from Josselin Mouette fixes it. Let me know if it's ok to commit
Comment 1 Emilio Pozuelo Monfort 2009-12-14 19:35:17 UTC
Created attachment 149720 [details] [review]
Fix NAME section
Comment 2 Cosimo Cecchi 2009-12-15 09:28:11 UTC
Review of attachment 149720 [details] [review]:

Looks good to me.
Comment 3 Emilio Pozuelo Monfort 2009-12-15 10:19:14 UTC
Thanks, pushed.

http://git.gnome.org/cgit/nautilus/commit/?id=fa563623570eeb6a0ab8d90aae386ecbbd740721