public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH v1] README.d/deps: Document dependencies of the project
@ 2026-02-08 14:45 Alejandro Colomar
  0 siblings, 0 replies; only message in thread
From: Alejandro Colomar @ 2026-02-08 14:45 UTC (permalink / raw)
  To: linux-man; +Cc: Alejandro Colomar

Signed-off-by: Alejandro Colomar <alx@kernel.org>
---
 README.d/deps | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 README.d/deps

diff --git a/README.d/deps b/README.d/deps
new file mode 100644
index 000000000..1b0314985
--- /dev/null
+++ b/README.d/deps
@@ -0,0 +1,60 @@
+Name
+	deps - software dependencies of this project
+
+Description
+	There are different kinds of software dependencies on which this
+	project depends.  For maintaining the health of this project,
+	the health of those dependencies is also essential.  The
+	following lists name dependencies are <debian-package>/<binary>.
+
+	Maintenance
+		Maintainers need some tools to read/write email, manage
+		the git repository, etc.  The essential ones we use are:
+
+		-  bash/bash
+		-  git/git
+		-  git-email/git-send-email
+		-  isync/mbsync
+		-  less/less
+		-  make/make
+		-  mutt/mutt
+		-  neomutt/neomutt
+		-  openssh-client/ssh
+		-  openssh-server/sshd
+		-  pass/pass
+		-  pass-otp/otp.bash
+		-  vim/vim
+		-  xfce4-terminal/xfce4-terminal
+
+		Of course, the OS is also a dependency.
+		Devuan GNU+Linux is the OS of choice of the current
+		maintainer.
+
+	Build
+		To build the project, there are many dependencies, some
+		of which are strictly necessary, and others improve the
+		quality (such as linters).
+
+		This list can be generated by the build system itself.
+		Run the following command to print this list:
+
+			$ make -R help-list-build-depends
+
+	Run-time
+		To read the manual pages, one needs two things:
+
+		Formatter
+			Several formatters exist.  Any of them should
+			work, more or less.  However, only two of them
+			are officially supported; and of these two,
+			groff typically has better support.
+
+			-  groff/groff
+			-  mandoc/mandoc
+
+		Librarian
+			Also several librarians exist.  Any of them
+			should work.  man-db has better support.
+
+			-  man-db/man
+			-  mandoc/mman

base-commit: be29e611a386b754fd5ce9f9d1ef421d15319ec1
prerequisite-patch-id: 38fbeafc19dc8addbe6f759046983fb96661d87f
-- 
2.51.0


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2026-02-08 14:45 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-02-08 14:45 [PATCH v1] README.d/deps: Document dependencies of the project Alejandro Colomar

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox