From 261b81a1492ab8797c6f436652a3b2fa38b3d63b Mon Sep 17 00:00:00 2001
From: Nikhil Ramakrishnan <ramakrishnan.nikhil@gmail.com>
Date: Fri, 3 Aug 2018 20:37:56 +0530
Subject: [PATCH] [builds] Add comment for the `BIN' variable.

Separate the definition of `BIN' in `*def.mk' files and add a comment
stating that it is being used for `make refdoc' and `make refdoc-venv'.
---
 builds/ansi/ansi-def.mk     | 4 +++-
 builds/beos/beos-def.mk     | 4 +++-
 builds/dos/dos-def.mk       | 4 +++-
 builds/os2/os2-def.mk       | 5 ++++-
 builds/unix/unix-def.in     | 2 +-
 builds/unix/unixddef.mk     | 3 +++
 builds/windows/win32-def.mk | 5 ++++-
 7 files changed, 21 insertions(+), 6 deletions(-)

diff --git a/builds/ansi/ansi-def.mk b/builds/ansi/ansi-def.mk
index 967fb62ef..f443426e3 100644
--- a/builds/ansi/ansi-def.mk
+++ b/builds/ansi/ansi-def.mk
@@ -16,10 +16,12 @@
 DELETE    := rm -f
 CAT       := cat
 SEP       := /
-BIN       := bin
 BUILD_DIR := $(TOP_DIR)/builds/ansi
 PLATFORM  := ansi
 
+# This is used for `make refdoc' and `make refdoc-venv'
+#
+BIN    := bin
 
 # The directory where all library files are placed.
 #
diff --git a/builds/beos/beos-def.mk b/builds/beos/beos-def.mk
index 350d74e15..f2aac142f 100644
--- a/builds/beos/beos-def.mk
+++ b/builds/beos/beos-def.mk
@@ -18,10 +18,12 @@
 DELETE    := rm -f
 CAT       := cat
 SEP       := /
-BIN       := bin
 BUILD_DIR := $(TOP_DIR)/builds/beos
 PLATFORM  := beos
 
+# This is used for `make refdoc' and `make refdoc-venv'
+#
+BIN    := bin
 
 # The directory where all library files are placed.
 #
diff --git a/builds/dos/dos-def.mk b/builds/dos/dos-def.mk
index 0845e9cc6..32c50730e 100644
--- a/builds/dos/dos-def.mk
+++ b/builds/dos/dos-def.mk
@@ -16,10 +16,12 @@
 DELETE    := del
 CAT       := type
 SEP       := $(strip \ )
-BIN       := Scripts
 BUILD_DIR := $(TOP_DIR)/builds/dos
 PLATFORM  := dos
 
+# This is used for `make refdoc' and `make refdoc-venv'
+#
+BIN    := Scripts
 
 # The executable file extension (for tools), *with* leading dot.
 #
diff --git a/builds/os2/os2-def.mk b/builds/os2/os2-def.mk
index 9c60f75f6..66ece6232 100644
--- a/builds/os2/os2-def.mk
+++ b/builds/os2/os2-def.mk
@@ -16,10 +16,13 @@
 DELETE    := del
 CAT       := type
 SEP       := $(strip \ )
-BIN       := Scripts
 BUILD_DIR := $(TOP_DIR)/builds/os2
 PLATFORM  := os2
 
+# This is used for `make refdoc' and `make refdoc-venv'
+#
+BIN    := Scripts
+
 # The executable file extension (for tools), *with* leading dot.
 #
 E := .exe
diff --git a/builds/unix/unix-def.in b/builds/unix/unix-def.in
index bc2350b37..7e824bc96 100644
--- a/builds/unix/unix-def.in
+++ b/builds/unix/unix-def.in
@@ -21,7 +21,7 @@ DELDIR := rm -rf
 CAT    := cat
 SEP    := /
 
-# this is used for `make refdoc' and `make refdoc-venv'
+# This is used for `make refdoc' and `make refdoc-venv'
 #
 PYTHON := @PYTHON@
 PIP    := @PIP@
diff --git a/builds/unix/unixddef.mk b/builds/unix/unixddef.mk
index d815746c7..d78042a92 100644
--- a/builds/unix/unixddef.mk
+++ b/builds/unix/unixddef.mk
@@ -22,6 +22,9 @@ PLATFORM := unix
 DELETE := rm -f
 CAT    := cat
 SEP    := /
+
+# This is used for `make refdoc' and `make refdoc-venv'
+#
 BIN    := bin
 
 # we use a special devel ftoption.h
diff --git a/builds/windows/win32-def.mk b/builds/windows/win32-def.mk
index e2d2628a2..c670d6553 100644
--- a/builds/windows/win32-def.mk
+++ b/builds/windows/win32-def.mk
@@ -16,10 +16,13 @@
 DELETE    := del
 CAT       := type
 SEP       := $(strip \ )
-BIN       := Scripts
 BUILD_DIR := $(TOP_DIR)/builds/windows
 PLATFORM  := windows
 
+# This is used for `make refdoc' and `make refdoc-venv'
+#
+BIN    := Scripts
+
 # The executable file extension (for tools). NOTE: WE INCLUDE THE DOT HERE !!
 #
 E := .exe