Page MenuHomeFreeBSD

fix the start of the code block in committers-guide
ClosedPublic

Authored by vladlen on Aug 9 2025, 12:09 PM.
Tags
Referenced Files
Unknown Object (File)
Fri, Oct 3, 11:01 AM
Unknown Object (File)
Sat, Sep 27, 3:27 PM
Unknown Object (File)
Wed, Sep 17, 1:04 PM
Unknown Object (File)
Sep 12 2025, 10:01 AM
Unknown Object (File)
Sep 10 2025, 6:11 AM
Unknown Object (File)
Sep 9 2025, 6:30 PM
Unknown Object (File)
Sep 6 2025, 8:31 PM
Unknown Object (File)
Aug 29 2025, 8:44 AM
Subscribers

Details

Summary

The current version of the articles/committers-guide has the code block without starting boundary (....). It simply located after the text "(the rest of ls.c has been omitted):"
As result the finishing boundary of this code block is considered as start of the code block for the next text paragraph. The consequences:

  1. The document is rendered to HTML with errors (the text is shown in the code block)
  2. All text fragments after this place are imported into the Weblate with wrong types: code blocks are imported as plain text type, and text paragraphs are imported as code block fragments. It creates troubles for translating and generating of correct documents for this article in national languages.

Proposed patch fixes this error in original document,

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.Aug 10 2025, 6:37 AM
bcr added inline comments.
documentation/content/en/articles/committers-guide/_index.adoc
837

Don't you need to preserve the "new sentence on new line" here?

documentation/content/en/articles/committers-guide/_index.adoc
837

I'll fix directly in the commit

Alright, nothing to complain about.

This revision was automatically updated to reflect the committed changes.