Bug 261815 - Spurious citerefentry left over in FDP primer 11.2 and spurious full stop
Summary: Spurious citerefentry left over in FDP primer 11.2 and spurious full stop
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: freebsd-doc (Nobody)
URL: https://docs.freebsd.org/en/books/fdp...
Keywords: needs-patch
Depends on:
Blocks:
 
Reported: 2022-02-09 06:35 UTC by Pau Amma
Modified: 2023-07-15 07:51 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Pau Amma 2022-02-09 06:35:05 UTC
In 11.2. Guidelines, "Avoid redundant phrases" has: "Manual page references (the second example uses citerefentry with the csh(1) entity):."

"citerefentry" is a holdover from DocBook times. Replace with the AsciiDoc equivalent. (I think it's "man:".) While there, get rid of the spurious "." after ":".
Comment 1 commit-hook freebsd_committer freebsd_triage 2023-07-15 07:51:01 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=02c2275c90bebf8befaa9ece1e3563d27fa09ff1

commit 02c2275c90bebf8befaa9ece1e3563d27fa09ff1
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-07-15 07:50:00 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-07-15 07:50:00 +0000

    FDP: Remove DocBook command and replace with AsciiDoc syntax

    PR:             261815
    Reported by:    Pau Amma <pauamma@gundo.com>

 documentation/content/en/books/fdp-primer/writing-style/_index.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 2 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-07-15 07:51:33 UTC
Fixed. Thanks!