[Bug 275745] Mk/bsd.local.mk: Propose renaming to bsd.local.mk.sample

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=275745

            Bug ID: 275745
           Summary: Mk/bsd.local.mk: Propose renaming to
                    bsd.local.mk.sample
           Product: Ports & Packages
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Some People
          Priority: ---
         Component: Ports Framework
          Assignee: portmgr@FreeBSD.org
          Reporter: jwb@freebsd.org
                CC: ports-bugs@FreeBSD.org

Currently, any changes to Mk/bsd.local.mk are part of the ports repo and must
be stashed before making commits.  Stashing is very slow, so this is an
annoyance.  Local changes can also be accidentally committed, which would be a
nuisance to fix.

I think it would be better to mimic plist's @sample, and provide a
bsd.local.mk.sample file that should never be locally modified.  I'd add a note
for NOOBs explaining how to use it as shown below.

--- bsd.local.mk        2023-12-12 13:58:29.486426000 -0600
+++ bsd.local.mk.sample 2023-12-13 08:01:56.210499000 -0600
@@ -1,4 +1,5 @@
 # bsd.local.mk - Sandbox for local modification to ports framework.
+# Copy this file to bsd.local.mk and modify as desired
 #

 .if !defined(_POSTMKINCLUDED) && !defined(Local_Pre_Include)

bsd.local.mk could also be added to .gitignore.

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