github-mirror/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2024-11-22 13:18:59 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fish documentation manpages: omit NAME for non-commands

Browse Source 
Documents like fish-tutorial don't need the NAME portion below.

(they also shoudln't be in section 1! These should be section 7,
they aren't for programs.)

the manpage writer will skip NAME if given an empty sstring as
the description.

--

FISH-TUTORIAL(1)     fish-shell     FISH-TUTORIAL(1)

NAME
       fish-tutorial - fish-shell tutorial
This commit is contained in:
Aaron Gyes 2021-11-05 07:46:27 -07:00
parent d54c8a42a9
commit 3078d0a252
3 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc_src/cmds/fish.rst
View File

@ -77,7 +77,7 @@ Debug messages output to stderr by default. Note that if ``fish_trace`` is set,
::
> fish --debug='complete,*history*' --debug-output=/tmp/fish.log --init-command='set fish_trace on'
These options can also be changed via the :envvar:`FISH_DEBUG` and :envvar:`FISH_DEBUG_OUTPUT` variables.
The categories enabled via ``--debug`` are *added* to the ones enabled by $FISH_DEBUG, so they can be disabled by prefixing them with ``-`` (``reader-*,-ast*`` enables reader debugging and disables ast debugging).

16
doc_src/conf.py
View File

@ -181,20 +181,20 @@ man_make_section_directory = False
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, "fish-doc", "fish-shell Documentation", [author], 1),
("tutorial", "fish-tutorial", "fish-shell tutorial", [author], 1),
("language", "fish-language", "The fish language", [author], 1),
("interactive", "fish-interactive", "Using fish interactively", [author], 1),
("relnotes", "fish-releasenotes", "fish-shell release notes", [author], 1),
("completions", "fish-completions", "Writing fish completions", [author], 1),
(master_doc, "fish-doc", "", [author], 1),
("tutorial", "fish-tutorial", "", [author], 1),
("language", "fish-language", "", [author], 1),
("interactive", "fish-interactive", "", [author], 1),
("relnotes", "fish-releasenotes", "", [author], 1),
("completions", "fish-completions", "", [author], 1),
(
"fish_for_bash_users",
"fish-for-bash-users",
"A quick fish primer for those coming from bash",
"",
[author],
1,
),
("faq", "fish-faq", "fish-shell faq", [author], 1),
("faq", "fish-faq", "", [author], 1),
]
for path in sorted(glob.glob("cmds/*")):
docname = os.path.splitext(path)[0]

6
doc_src/language.rst
View File

@ -1254,11 +1254,9 @@ Special variables
You can change the settings of fish by changing the values of certain variables.
.. _PATH:
.. envvar:: PATH
A list of directories in which to search for commands
A list of directories in which to search for commands.
.. envvar:: CDPATH
@ -1274,7 +1272,7 @@ You can change the settings of fish by changing the values of certain variables.
.. describe:: Locale Variables
The locale variables :envvar:`CDPATH`, :envvar:`LANG`, :envvar:`LC_ALL`, :envvar:`LC_COLLATE`, :envvar:`LC_CTYPE`, :envvar:`LC_MESSAGES`, :envvar:`LC_MONETARY`, :envvar:`LC_NUMERIC`, and :envvar:`LANG` set the language option for the shell and subprograms. See the section :ref:`Locale variables <variables-locale>` for more information.
The locale variables :envvar:`LANG`, :envvar:`LC_ALL`, :envvar:`LC_COLLATE`, :envvar:`LC_CTYPE`, :envvar:`LC_MESSAGES`, :envvar:`LC_MONETARY`, :envvar:`LC_NUMERIC`, and :envvar:`LANG` set the language option for the shell and subprograms. See the section :ref:`Locale variables <variables-locale>` for more information.
.. seealso:: Others include: