INSTALL: Add more pod markup #23726
Open
INSTALL: Add more pod markup #23726
+362
−315
Conversation
This file contains hidden or 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
Contributor
khwilliamson
commented
Sep 18, 2025
khwilliamson
commented
- This set of changes does not require a perldelta entry.
This gives more complete advice to someone reading this document about how to read it.
This adds =for apidoc lines to INSTALL for use by autodoc.pl
Grinnz
reviewed
Sep 18, 2025
|
|
||
| After it runs, Configure will perform variable substitution on all the | ||
| *.SH files and offer to run make depend. | ||
| *.SH files and offer to run S<C<make depend>>. |
There was a problem hiding this comment.
Just tested out this construct in an HTML renderer (never used S before) and C<S<foo bar>> successfully applies the nowrap style but S<C<foo bar>> does not due to the nesting of span and code elements. Either seems to work for commandline perldoc.
There was a problem hiding this comment.
That's good to know, and we should document this issue. It is a problem when the C<> is for just a subset of what needs to be on the same line. It also needs to be documented that for links to the same pod, you should use C<L/<...>> vs on a different pod, L<C<...>>
Grinnz
reviewed
Sep 18, 2025
INSTALL
Outdated
| option when prompted by Configure. If your libraries are not in a | ||
| directory normally searched by your C compiler and linker, then you will | ||
| need to include the appropriate -L/your/directory option when prompted | ||
| need to include the appropriate -L/>I<your/directory> option when prompted |
There's more that could be added; but this is a lot
khwilliamson
force-pushed
the
INSTALL_api
branch
from
a0e474f to
a6ba45e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.