Bug 253554 - Incorrect $FreeBSD$ expansion in Building Products articles
Summary: Incorrect $FreeBSD$ expansion in Building Products articles
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Sergio Carlavilla Delgado
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2021-02-16 12:10 UTC by Ceri Davies
Modified: 2021-02-16 21:50 UTC (History)
2 users (show)

See Also:


Attachments
Patch which may correct this (1.05 KB, patch)
2021-02-16 12:10 UTC, Ceri Davies
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ceri Davies 2021-02-16 12:10:55 UTC
Created attachment 222485 [details]
Patch which may correct this

There is an incorrect expansion of $FreeBSD$ in the building products article.

I don't know what expansion looks like in the git world, but have submitted a patch which *may* fix it.
Comment 1 Daniel Ebdrup Jensen freebsd_committer 2021-02-16 12:21:05 UTC
git doesn't support RCS expansions at all, so it's better to get rid of it all-together.

Hugo (or AsciiDoctor) has a facility for doing this, I believe?
Comment 2 Ceri Davies 2021-02-16 12:22:01 UTC
That's probably good then, as it shouldn't be expanded :)
Comment 3 Sergio Carlavilla Delgado freebsd_committer 2021-02-16 21:32:46 UTC
I'm not going to commit this patch. Right now the entirely section talks about svn. So this change don't make any sense. If you want you can convert the whole section to git.
Comment 4 Ceri Davies 2021-02-16 21:42:14 UTC
I have no idea what’s in place for third parties as it’s not documented, so I can’t do that. Feel free to close this if you’d prefer a confusing expansion to be left there.
Comment 5 Sergio Carlavilla Delgado freebsd_committer 2021-02-16 21:47:45 UTC
My fault, I see your point. And after entering in the article [1] I saw your point.
The svn expansion macro expanded this text but it shouldn't be expanded.

[1] https://docs.freebsd.org/en/articles/building-products/
Comment 6 commit-hook freebsd_committer 2021-02-16 21:50:19 UTC
A commit in branch main references this bug:

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

commit e7ea1aea59f30bb4f7a9e322aaf9f0635d888035
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2021-02-16 21:48:12 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2021-02-16 21:48:12 +0000

    Incorrect $FreeBSD$ expansion in Building Products articles

    PR:         253554
    Patch by:   ceri (AT) submonkey.net

 documentation/content/en/articles/building-products/_index.adoc | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Comment 7 Sergio Carlavilla Delgado freebsd_committer 2021-02-16 21:50:45 UTC
Fixed. Thanks!