[Bug 269243] Shell syntax highlighting is broken in some places

From: <bugzilla-noreply_at_freebsd.org>
Date: Mon, 30 Jan 2023 12:35:30 UTC

            Bug ID: 269243
           Summary: Shell syntax highlighting is broken in some places
           Product: Documentation
           Version: Latest
          Hardware: Any
               URL: https://docs.freebsd.org/en/books/handbook/basics/#use
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Books & Articles
          Assignee: doc@FreeBSD.org
          Reporter: ciaranainsworth@posteo.net

Created attachment 239805
  --> https://bugs.freebsd.org/bugzilla/attachment.cgi?id=239805&action=edit
A screenshot showing broken syntax highlighting

I didn't find any issues relating to this, so please close this down if it's
already being tackled elsewhere.

I noticed while editing a page recently that the syntax highlighting in VS Code
wasn't happy with the formatting of some of the text. It looks like this is
caused by unescaped single quotes in some of the code blocks. These are making
the highlighter unhappy and are causing some oddities in the application of
syntax highlighting in the published pages (see attached).

Rather than escaping these, I think the solution is to mark these blocks as
"console" rather than "shell". The code in question is not a shell script but
rather a console prompt. If we change the highlighting, this fixes the
highlighter's complaint in the IDE and also unifies the highlighting in the
published article.

This issue may be in quite a few places, so I'm not sure whether it is best to
tackle this as one large patch or to split it up.

You are receiving this mail because:
You are the assignee for the bug.