Skip to content

doc: Clean up roff source in manpage #7819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Alhadis wants to merge 6 commits into from
+47 −16
Closed

doc: Clean up roff source in manpage #7819

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4a24590
doc: Clean up roff source in manpage
Alhadis Jul 21, 2016
82a2cde
Strip trailing whitespace
Alhadis Jul 21, 2016
ae90a72
Add brief description for URL-formatting macro
Alhadis Jul 21, 2016
4500432
Delete redundant .fi request
Alhadis Jul 21, 2016
57e48cb
Use correct name for Roff typesetting language
Alhadis Jul 21, 2016
3a30132
Delete empty lines
Alhadis Aug 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add brief description for URL-formatting macro
  • Loading branch information
@Alhadis
Alhadis committed Jul 21, 2016
commit ae90a7292dd1d7081d7ffd1e9cc092d62c2f720d
2 changes: 2 additions & 0 deletions doc/node.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
.
.\" See http://liw.fi/manpages/ for an overview, or http://www.troff.org/54.pdf
.\" for detailed language reference.
.
.\" Macro to display an underlined URL in bold
.de ur
Copy link
Copy Markdown
Contributor

@Fishrock123 Fishrock123 Jul 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

.\" for detailed language reference.

.\" Macros

?

Copy link
Copy Markdown
Contributor Author

@Alhadis Alhadis Jul 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what's being asked here... is this concerning the first or second line?

  1. I felt impelled to offer readers a link to a more authoritative resource on the language, as the former link, while helpful, is extremely limited and only covers very rudimentary aspects of the language.
  2. The macro is simply a cleaner way of formatting the links below. Ordinarily I would've used the .UR/.UE macros provided by Groff's an-ext.tmac, but I'm aware that this isn't available on all systems. I wanted to guarantee this manpage would pose no portability issues. Which is also the reason I named the macro .ur instead of .url, as classical troff didn't permit macro names longer than 2 characters.

Copy link
Copy Markdown
Contributor

@Fishrock123 Fishrock123 Jul 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I think we should add a comment about the macro, and probably a space above it, that is all. Sorry for the confusion.

Copy link
Copy Markdown
Contributor Author

@Alhadis Alhadis Jul 21, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you want me to amend an explanation? :)

And as for the .fi request, did you want me to kill it off?

(Built-in language functions are what're known as "requests" in Roff terminology. User-defined routines constructed using requests are known as "macros". Both have identical syntax)

.nr CF \\n(.f
.ft 4
Expand Down