git: c77ca9a72c99 - main - stale-symlink-buildworld.sh: improve documentation

The branch main has been updated by wosch:

URL: https://cgit.FreeBSD.org/src/commit/?id=c77ca9a72c9934c407852f00d88cba09f5c9e31f

commit c77ca9a72c9934c407852f00d88cba09f5c9e31f
Author:     Wolfram Schneider <wosch@FreeBSD.org>
AuthorDate: 2024-09-09 14:55:29 +0000
Commit:     Wolfram Schneider <wosch@FreeBSD.org>
CommitDate: 2024-09-09 14:55:29 +0000

    stale-symlink-buildworld.sh: improve documentation
---
 tools/build/stale-symlink-buildworld.sh | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/tools/build/stale-symlink-buildworld.sh b/tools/build/stale-symlink-buildworld.sh
index 32ebc1f9d66d..acc3fb0baaf2 100755
--- a/tools/build/stale-symlink-buildworld.sh
+++ b/tools/build/stale-symlink-buildworld.sh
@@ -4,8 +4,17 @@
 #
 # stale-symlink-buildworld.sh - check for stale symlinks on a FreeBSD system
 #
-# You can run the script before or after `make installworld'
+# The purpose of this script is to detect stale symlinks, report them to
+# stderr and exit with a non-zero status. All other cases are ignored,
+# such as no symlinks, missing directories, permission problems, etc.
 #
+# You can run the script before or after `make installworld', or any other
+# make targets thats installs files.
+#
+# You can also check your local ports with:
+#    
+#   env STALE_SYMLINK_BUILDWORLD_DIRS=/usr/local ./stale-symlink-buildworld.sh
+
 
 PATH="/bin:/usr/bin"; export PATH