From 193ec51c41a2198ac73959d7a7b2af4ae44f6955 Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sun, 1 Oct 2023 15:37:59 -0500 Subject: [PATCH] Give the database connection variables their own doc heading --- Makefile | 1 - make_files/db_doc_header.mk | 28 ---------------------------- make_files/defaults.mk | 11 ++++++++--- make_files/make_db.mk | 9 +++++++++ 4 files changed, 17 insertions(+), 32 deletions(-) delete mode 100644 make_files/db_doc_header.mk diff --git a/Makefile b/Makefile index 2fe163c..35f2265 100644 --- a/Makefile +++ b/Makefile @@ -53,7 +53,6 @@ clean: clean-docs clean-db # (Split into various files for improved digestion.) # -include $(MAKE_FILES)/db_doc_header.mk # Defaults for variable values # Have a look as you'll probably want to set some of them. include $(MAKE_FILES)/defaults.mk diff --git a/make_files/db_doc_header.mk b/make_files/db_doc_header.mk deleted file mode 100644 index 6e7eec4..0000000 --- a/make_files/db_doc_header.mk +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright (C) 2023 The Meme Factory, Inc. www.karlpinc.com -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as -# published by the Free Software Foundation, either version 3 of the -# License, or (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . -# -# Karl O. Pinc - -# This file exists only to give the database section of the Makefile -# documentation a breakpoint/header. - -## -## ######################################################################## -## DATABASE TARGETS -## -## Unless otherwise noted, database modification takes place in a transaction. -## -## Variables: -## diff --git a/make_files/defaults.mk b/make_files/defaults.mk index a945572..05de3dd 100644 --- a/make_files/defaults.mk +++ b/make_files/defaults.mk @@ -21,9 +21,10 @@ # # Karl O. Pinc -# -# Database Connection Variables: -# +## +## ######################################################################## +## DATABASE CONNECTION VARIABLES +## ## TARGET_DB ## The name of the database with which to interact. The default ## is 'sokwedb_copy'. @@ -36,6 +37,10 @@ ## HOST ## The host hosting the database. The default is: ## sokwe-dbs.postgres.database.azure.com +## +## These variables are used throughout whenever a connection to the database +## must be made. +## ifeq ($(strip $(TARGET_DB)),) export TARGET_DB := sokwedb_copy diff --git a/make_files/make_db.mk b/make_files/make_db.mk index 2d17ffa..cc64750 100644 --- a/make_files/make_db.mk +++ b/make_files/make_db.mk @@ -43,6 +43,15 @@ # Variables which might be set on the command line: # + +## +## ######################################################################## +## DATABASE TARGETS +## +## Unless otherwise noted, database modification takes place in a transaction. +## +## Variables: +## ## ## Variables used by only some targets: ## -- 2.34.1