Page MenuHomeFreeBSD

Use the man: keyword instead of {{< manpage >}}.
ClosedPublic

Authored by jhb on Mar 15 2021, 10:46 PM.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

jhb requested review of this revision.Mar 15 2021, 10:46 PM
jhb created this revision.

I'm not an asciidoc expert, do we have some local docs for these?

I'm not an asciidoc expert, do we have some local docs for these?

I'm unsure where exactly they got added, but the first use of it was by @gjb with 1833fecccb4.

If all else fails, we can try asking @carlavilla.

Nevermind, just after I wrote that, I remembered something.
It's implemented using doc/shared/lib/ManPageMacro/extension.rb

Honestly, I had written most of the next change using the old syntax and then saw this in some new changes when I rebased. I already had in my mind to ask for a shorter syntax as the old one is pretty verbose, especially compared to the old SGML entities we had for DocBook. The man: keyword is quite nice though and is as compact as the old style.

This revision is now accepted and ready to land.Mar 15 2021, 11:45 PM
In D29278#655642, @jhb wrote:

Honestly, I had written most of the next change using the old syntax and then saw this in some new changes when I rebased. I already had in my mind to ask for a shorter syntax as the old one is pretty verbose, especially compared to the old SGML entities we had for DocBook. The man: keyword is quite nice though and is as compact as the old style.

I like the ruby macro processed keywords better too, so if nobody else steps up I'll probably do a pass to change all of them?

Assuming this looks good once rendered using make run or make build, you've got my approval to commit it.