From 3d5f678da21d1c0bad501b481e67d0a9ba33542a Mon Sep 17 00:00:00 2001
From: Mats Wichmann <mats@linux.com>
Date: Sun, 2 Aug 2020 09:46:19 -0600
Subject: Minor: add a comment about options to manpage source  [ci skip]

Explain why we don't use this form of listing options in manpage:
  <varlistentry><term>-A</term><term>--a-long-opt</term>...
i.e. a term for each variant of an option.
This is a comment only, no change to actual manpage.

Signed-off-by: Mats Wichmann <mats@linux.com>
---
 doc/man/scons.xml | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/man/scons.xml b/doc/man/scons.xml
index b33c035..29ace2d 100644
--- a/doc/man/scons.xml
+++ b/doc/man/scons.xml
@@ -487,6 +487,11 @@ supports the same command-line options as GNU &Make;
 and many of those supported by <application>cons</application>.
 </para>
 
+<!-- The recommended approach of multiple <term> entries per <varlistentry> -->
+<!-- (if needed) is not used for Options, as the default presentation -->
+<!-- format for a varlist is changed from csv to one-per-line to improve -->
+<!-- display of Builders and Functions/Methods. Do the csv manually. -->
+
 <!-- Note: commented-out options are retained as they may be a model -->
 <!-- for future development directions. Do not remove. -->
 
-- 
cgit v0.12