-
Notifications
You must be signed in to change notification settings - Fork 318
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Documentation changes: - Document trace and require - Add variable index - Remove explicit links from @node lines, since makeinfo figures this out anyway and they would make automagic contrib/ documentation inclusion harder. - add file TEXINFO-HINTS * Documentation infractructure changes: - document functions etc. with package prefix; index without package prefix too (makeinfo seems to index the name with prefix without being asked, so we just lay back and enjoy it) - Move list-of-packages-to-extract-docstrings-from to Makefile - Escape Texinfo special characters in documentation bodies as well.
- Loading branch information
Showing
13 changed files
with
211 additions
and
276 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
-*- text -*- | ||
|
||
Some hints for editing the manual files. Feel free to add anything | ||
that will save the next person some time. Thanks! | ||
|
||
|
||
- There's no need for Next, Prev, etc. pointers in @node lines: | ||
makeinfo will deduce these automatically when the line after @node | ||
contains a sectioning command like @section, @subsection. Hence, | ||
texinfo-multiple-files-update should not be used either. | ||
|
||
- Don't create or update Menus by hand; use C-c C-u C-a | ||
(texinfo-all-menus-update) instead. (Doesn't work in sbcl.texinfo, | ||
but this file is only changed when an entire chapter is added.) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.