[Bug 290832] style.mdoc.5: Document /usr/src/foo vs src/foo preference (also for /usr/ports/foo vs ports/foo)

From: <bugzilla-noreply_at_freebsd.org>
Date: Thu, 06 Nov 2025 13:13:31 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=290832

            Bug ID: 290832
           Summary: style.mdoc.5: Document /usr/src/foo vs src/foo
                    preference (also for /usr/ports/foo vs ports/foo)
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Keywords: needs-patch
          Severity: Affects Only Me
          Priority: ---
         Component: Manual Pages
          Assignee: bugs@FreeBSD.org
          Reporter: 0mp@FreeBSD.org
                CC: doc@FreeBSD.org

I've noticed there is a preference to refer to files in /usr/src and /usr/ports
using relative paths instead of absolute ones. My understanding is that this is
because we do not want to signal that those repositories need to be checked out
to a specific place in the file system in order to work.

We should document that.

-- 
You are receiving this mail because:
You are on the CC list for the bug.