Github/emacs
2
0
Fork 1
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-16 17:24:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

; Improve recently added documentation

Browse source 
* etc/NEWS:
* doc/lispref/tips.texi (Documentation Tips): Improve and clarify
recently-added documentation of man page references.
This commit is contained in:
Eli Zaretskii 2021-09-25 09:59:53 +03:00
parent 83e08dfef3
commit f82f3d62ad
2 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/lispref/tips.texi
View file

@ -760,9 +760,15 @@ man page, preceded by @samp{Man page}, @samp{man page}, or @samp{man
page for}. For example,
@smallexample
See the man page `chmod' for details.
See the man page `chmod(1)' for details.
@end smallexample
@noindent
The Info documentation is always preferable to man pages, so be sure
to link to an Info manual where available. For example,
@command{chmod} is documented in the GNU Coreutils manual, so it is
better to link to that instead of the man page.
To link to a customization group, write the single-quoted name of the
group, preceded by @samp{customization group} (the first character in
each word is case-insensitive). For example,

2
etc/NEWS
View file

@ -3710,7 +3710,7 @@ customization group.
+++
** Doc strings can now link to man pages.
Text like "man page `chmod'" will be made into a button. When
Text like "man page `chmod(1)'" will be made into a button. When
clicked, it will open a Man mode buffer displaying that man page.
+++