From 86feafb7211445f617b14c3ec04ae08e4e26bff9 Mon Sep 17 00:00:00 2001 From: Andrew Wood Date: Sun, 3 Sep 2023 00:40:26 +0100 Subject: [PATCH] Rename "doc" directory to "docs" to match Debian standards. --- Makefile.am | 10 +++++----- README.md | 12 ++++++------ configure.ac | 2 +- {doc => docs}/ACKNOWLEDGEMENTS.md | 0 {doc => docs}/COPYING | 0 {doc => docs}/DEVELOPERS.md | 10 +++++----- {doc => docs}/INSTALL | 0 {doc => docs}/NEWS.md | 0 {doc => docs}/TODO.md | 0 {doc => docs}/benchmark.sh | 0 {doc => docs}/pv.1 | 0 {doc => docs}/pv.1.md | 0 src/include/config-aux.h | 2 +- src/include/options.h | 2 +- src/include/pv-internal.h | 2 +- src/include/pv.h | 2 +- src/main/debug.c | 2 +- src/main/help.c | 2 +- src/main/main.c | 2 +- src/main/options.c | 2 +- src/main/remote.c | 2 +- src/main/version.c | 2 +- src/pv/cursor.c | 2 +- src/pv/display.c | 2 +- src/pv/elapsedtime.c | 2 +- src/pv/file.c | 2 +- src/pv/loop.c | 2 +- src/pv/number.c | 2 +- src/pv/signal.c | 2 +- src/pv/state.c | 2 +- src/pv/string.c | 2 +- src/pv/transfer.c | 2 +- src/pv/watchpid.c | 2 +- 33 files changed, 38 insertions(+), 38 deletions(-) rename {doc => docs}/ACKNOWLEDGEMENTS.md (100%) rename {doc => docs}/COPYING (100%) rename {doc => docs}/DEVELOPERS.md (94%) rename {doc => docs}/INSTALL (100%) rename {doc => docs}/NEWS.md (100%) rename {doc => docs}/TODO.md (100%) rename {doc => docs}/benchmark.sh (100%) rename {doc => docs}/pv.1 (100%) rename {doc => docs}/pv.1.md (100%) diff --git a/Makefile.am b/Makefile.am index a8a8c6b..022bf99 100644 --- a/Makefile.am +++ b/Makefile.am @@ -5,10 +5,10 @@ AUTOMAKE_OPTIONS = subdir-objects SUBDIRS = po bin_PROGRAMS = pv -dist_doc_DATA = README.md doc/INSTALL doc/COPYING doc/NEWS.md doc/ACKNOWLEDGEMENTS.md doc/DEVELOPERS.md doc/TODO.md doc/benchmark.sh -dist_man1_MANS = doc/pv.1 +dist_doc_DATA = README.md docs/INSTALL docs/COPYING docs/NEWS.md docs/ACKNOWLEDGEMENTS.md docs/DEVELOPERS.md docs/TODO.md docs/benchmark.sh +dist_man1_MANS = docs/pv.1 -EXTRA_DIST = doc/pv.1.md +EXTRA_DIST = docs/pv.1.md pv_SOURCES = \ src/main/debug.c \ @@ -84,8 +84,8 @@ tests/Transfer_-_--stop-at-size.test EXTRA_DIST += $(TESTS) tests/run-valgrind.sh tests/test-env.sh -doc/pv.1.md: $(srcdir)/doc/pv.1 - test -d doc || mkdir doc +docs/pv.1.md: $(srcdir)/docs/pv.1 + test -d docs || mkdir docs pandoc --from man --to markdown < $< | sed '/\*\*\*\*/{s/\*//g;s/^/**/;s/$$/**/}' | sed '/^```/,/^```/d' > $@ SUFFIXES = .c .o .e diff --git a/README.md b/README.md index a69e650..cdaa0e7 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ Documentation ------------- A manual page is included in this distribution ("`man pv`"). Before -installation, it is in "[doc/pv.1](./doc/pv.1.md)". +installation, it is in "[docs/pv.1](./docs/pv.1.md)". -Changes are listed in "[doc/NEWS.md](./doc/NEWS.md)". The to-do list is "[doc/TODO.md](./doc/TODO.md)". +Changes are listed in "[docs/NEWS.md](./docs/NEWS.md)". The to-do list is "[docs/TODO.md](./docs/TODO.md)". -Developers and translators, please see "[doc/DEVELOPERS.md](./doc/DEVELOPERS.md)". +Developers and translators, please see "[docs/DEVELOPERS.md](./docs/DEVELOPERS.md)". Compilation @@ -26,7 +26,7 @@ To compile the package, type "`sh ./configure`", which should generate a Makefile for your system. You may then type "`make`" to build everything, and "`make install`" to install it. -See the file "[doc/INSTALL](./doc/INSTALL)" for more about the _configure_ script. +See the file "[docs/INSTALL](./docs/INSTALL)" for more about the _configure_ script. If this is not a packaged release, you will need the GNU build system tools (`autoconf`, `aclocal`, `autopoint`, `automake`) and the `gettext` @@ -39,7 +39,7 @@ Author and acknowledgements This package is copyright 2023 Andrew Wood, and is being distributed under the terms of the Artistic License 2.0. For more details of this license, -see the file "[doc/COPYING](./doc/COPYING)". +see the file "[docs/COPYING](./docs/COPYING)". Report bugs in **pv** using the contact form linked from the home page, or though the [project issue tracker](https://codeberg.org/a-j-wood/pv/issues). @@ -50,6 +50,6 @@ The **pv** home page is at: The latest version can always be found here. -**Please see "[doc/ACKNOWLEDGEMENTS.md](./doc/ACKNOWLEDGEMENTS.md)" for a list of contributors.** +**Please see "[docs/ACKNOWLEDGEMENTS.md](./docs/ACKNOWLEDGEMENTS.md)" for a list of contributors.** --- diff --git a/configure.ac b/configure.ac index ff915fa..07fff86 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ dnl Process this file with autoconf to produce a configure script. dnl dnl Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood dnl -dnl Distributed under the Artistic License v2.0; see `doc/COPYING'. +dnl Distributed under the Artistic License v2.0; see `docs/COPYING'. AC_INIT([pv], [0.0.20230902-UNRELEASED], [https://codeberg.org/a-j-wood/pv/issues], [pv], [https://www.ivarch.com/programs/pv.shtml]) AC_CONFIG_SRCDIR([src/include/config.h.in]) diff --git a/doc/ACKNOWLEDGEMENTS.md b/docs/ACKNOWLEDGEMENTS.md similarity index 100% rename from doc/ACKNOWLEDGEMENTS.md rename to docs/ACKNOWLEDGEMENTS.md diff --git a/doc/COPYING b/docs/COPYING similarity index 100% rename from doc/COPYING rename to docs/COPYING diff --git a/doc/DEVELOPERS.md b/docs/DEVELOPERS.md similarity index 94% rename from doc/DEVELOPERS.md rename to docs/DEVELOPERS.md index deb5fbb..2f66a40 100644 --- a/doc/DEVELOPERS.md +++ b/docs/DEVELOPERS.md @@ -105,11 +105,11 @@ The package maintainer should run through these steps for a new release: * Check for patches and bug reports at https://tracker.debian.org/pkg/pv * Run "`make indent; make indent indentclean update-po check`" * Version bump and documentation checks: - * Update the version in `configure.ac` and `doc/NEWS.md` - * Check that `doc/NEWS.md` is up to date - * Check that `doc/TODO.md` is up to date - * Check that the manual `doc/pv.1` is up to date - * Run "`make doc/pv.1.md`" and, if using VPATH, copy the result to the source directory + * Update the version in `configure.ac` and `docs/NEWS.md` + * Check that `docs/NEWS.md` is up to date + * Check that `docs/TODO.md` is up to date + * Check that the manual `docs/pv.1` is up to date + * Run "`make docs/pv.1.md`" and, if using VPATH, copy the result to the source directory * Ensure everything has been committed to the repository * Run "`autoreconf`" in the source directory * Consistency and build checks: diff --git a/doc/INSTALL b/docs/INSTALL similarity index 100% rename from doc/INSTALL rename to docs/INSTALL diff --git a/doc/NEWS.md b/docs/NEWS.md similarity index 100% rename from doc/NEWS.md rename to docs/NEWS.md diff --git a/doc/TODO.md b/docs/TODO.md similarity index 100% rename from doc/TODO.md rename to docs/TODO.md diff --git a/doc/benchmark.sh b/docs/benchmark.sh similarity index 100% rename from doc/benchmark.sh rename to docs/benchmark.sh diff --git a/doc/pv.1 b/docs/pv.1 similarity index 100% rename from doc/pv.1 rename to docs/pv.1 diff --git a/doc/pv.1.md b/docs/pv.1.md similarity index 100% rename from doc/pv.1.md rename to docs/pv.1.md diff --git a/src/include/config-aux.h b/src/include/config-aux.h index 96b9763..a2cec8e 100644 --- a/src/include/config-aux.h +++ b/src/include/config-aux.h @@ -5,7 +5,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #if ENABLE_NLS diff --git a/src/include/options.h b/src/include/options.h index 0748401..b277d1a 100644 --- a/src/include/options.h +++ b/src/include/options.h @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #ifndef _OPTIONS_H diff --git a/src/include/pv-internal.h b/src/include/pv-internal.h index 5ba8f8c..352b704 100644 --- a/src/include/pv-internal.h +++ b/src/include/pv-internal.h @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #ifndef _PV_INTERNAL_H diff --git a/src/include/pv.h b/src/include/pv.h index 79a5b0f..3ca43be 100644 --- a/src/include/pv.h +++ b/src/include/pv.h @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #ifndef _PV_H diff --git a/src/main/debug.c b/src/main/debug.c index de2960b..d768ac3 100644 --- a/src/main/debug.c +++ b/src/main/debug.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/main/help.c b/src/main/help.c index caaaec1..f3835d0 100644 --- a/src/main/help.c +++ b/src/main/help.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/main/main.c b/src/main/main.c index 7d60bc8..f80b415 100644 --- a/src/main/main.c +++ b/src/main/main.c @@ -4,7 +4,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/main/options.c b/src/main/options.c index 5a2aee9..93d039a 100644 --- a/src/main/options.c +++ b/src/main/options.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/main/remote.c b/src/main/remote.c index 4f49089..53548aa 100644 --- a/src/main/remote.c +++ b/src/main/remote.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/main/version.c b/src/main/version.c index 0fe4908..0c7fd36 100644 --- a/src/main/version.c +++ b/src/main/version.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/cursor.c b/src/pv/cursor.c index 97eea97..8d040e1 100644 --- a/src/pv/cursor.c +++ b/src/pv/cursor.c @@ -12,7 +12,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/display.c b/src/pv/display.c index 715ed45..309cb55 100644 --- a/src/pv/display.c +++ b/src/pv/display.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/elapsedtime.c b/src/pv/elapsedtime.c index f0a7fc5..0c49af3 100644 --- a/src/pv/elapsedtime.c +++ b/src/pv/elapsedtime.c @@ -3,7 +3,7 @@ * * Copyright 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/file.c b/src/pv/file.c index 8cd9dbd..bccfe15 100644 --- a/src/pv/file.c +++ b/src/pv/file.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/loop.c b/src/pv/loop.c index 9255f94..1d95a61 100644 --- a/src/pv/loop.c +++ b/src/pv/loop.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/number.c b/src/pv/number.c index 7b797fe..2643b20 100644 --- a/src/pv/number.c +++ b/src/pv/number.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/signal.c b/src/pv/signal.c index 093e5c2..4154ea4 100644 --- a/src/pv/signal.c +++ b/src/pv/signal.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/state.c b/src/pv/state.c index 1dccd03..7117de2 100644 --- a/src/pv/state.c +++ b/src/pv/state.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/string.c b/src/pv/string.c index 9e58f08..00d06bb 100644 --- a/src/pv/string.c +++ b/src/pv/string.c @@ -3,7 +3,7 @@ * * Copyright 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/transfer.c b/src/pv/transfer.c index 6f5ff71..4d41ba8 100644 --- a/src/pv/transfer.c +++ b/src/pv/transfer.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h" diff --git a/src/pv/watchpid.c b/src/pv/watchpid.c index 0b38e7a..40fbd62 100644 --- a/src/pv/watchpid.c +++ b/src/pv/watchpid.c @@ -3,7 +3,7 @@ * * Copyright 2002-2008, 2010, 2012-2015, 2017, 2021, 2023 Andrew Wood * - * Distributed under the Artistic License v2.0; see `doc/COPYING'. + * Distributed under the Artistic License v2.0; see `docs/COPYING'. */ #include "config.h"