Page MenuHomeFreeBSD

documentation: fix crossref macro with comma in parameter
ClosedPublic

Authored by vladlen on Sun, Jul 5, 7:10 PM.
Tags
Referenced Files
F162305896: D58046.id181318.diff
Sat, Jul 11, 9:36 PM
F162305225: D58046.id181318.diff
Sat, Jul 11, 9:27 PM
F162280498: D58046.id181478.diff
Sat, Jul 11, 4:09 PM
F162280138: D58046.id181478.diff
Sat, Jul 11, 4:06 PM
Unknown Object (File)
Fri, Jul 10, 2:26 PM
Unknown Object (File)
Fri, Jul 10, 10:54 AM
Unknown Object (File)
Fri, Jul 10, 10:48 AM
Unknown Object (File)
Wed, Jul 8, 4:22 AM
Subscribers
None

Details

Summary

This patch fixes all crossref macro usages where the second
parameter included a comma. Such parameters are now enclosed
in double quotes to prevent the comma from being interpreted
as a parameter separator and truncating the link text.

Additionally, an [IMPORTANT] note has been added to the
FDP Primer (Chapter: Links to the same file or to another file in the same book)
to document this requirement for future contributors.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

vladlen created this revision.
This revision is now accepted and ready to land.Mon, Jul 6, 8:28 PM