From 553ba561573e6d0b160a7d38a1fb1eb511210778 Mon Sep 17 00:00:00 2001
From: "Karl O. Pinc" <kop@karlpinc.com>
Date: Fri, 1 Sep 2023 12:13:42 -0500
Subject: [PATCH] Document the PEOPLE.Active column

---
 doc/src/code_tables.m4 | 14 ++++++++++++++
 doc/src/epilog.inc.m4  |  1 +
 2 files changed, 15 insertions(+)

diff --git a/doc/src/code_tables.m4 b/doc/src/code_tables.m4
index 73fa6db..99dca75 100644
--- a/doc/src/code_tables.m4
+++ b/doc/src/code_tables.m4
@@ -245,6 +245,20 @@ Description
 |PEOPLE.Description_summary| |notonlyspaces| |notnull|
 
 
+.. _PEOPLE.Active:
+
+Active
+``````
+
+.. |PEOPLE.Active_summary| replace::
+   A |boolean| value.  Whether or not the row can be used in new data.
+   
+|PEOPLE.Active_summary| When this column is |false| the
+:ref:`PEOPLE.Name` value cannot be used in rows that are newly
+inserted into the database.  Further, when rows are updated an
+existing value cannot be set to the inactive :ref:`PEOPLE.Name`.
+|notnull|
+
 .. rubric:: Footnotes
 
 .. [#f14] The database could accept the full-set of Unicode characters,
diff --git a/doc/src/epilog.inc.m4 b/doc/src/epilog.inc.m4
index 9cbaa82..341f0bb 100644
--- a/doc/src/epilog.inc.m4
+++ b/doc/src/epilog.inc.m4
@@ -78,6 +78,7 @@ sdb_generated_rst()dnl
 
 .. |PEOPLE| replace:: :ref:`PEOPLE <PEOPLE>`
 .. |PEOPLE.Person| replace:: :ref:`Person <PEOPLE.Person>`
+.. |PEOPLE.Active| replace:: :ref:`Active <PEOPLE.Active>`
 
 
 .. Function substitutions, which exist for the same reason
-- 
2.34.1