mirrors/pv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename "doc" directory to "docs" to match Debian standards.

Browse Source
This commit is contained in:
Andrew Wood
2023-09-03 00:40:26 +01:00
parent 57f66c0b99
commit 86feafb721
33 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile.am
+5 -5
View File
@@ -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
README.md
+6 -6
View File
@@ -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.**
---
configure.ac
+1 -1
View File
@@ -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])
doc/ACKNOWLEDGEMENTS.md → docs/ACKNOWLEDGEMENTS.md
View File
doc/COPYING → docs/COPYING
View File
doc/DEVELOPERS.md → docs/DEVELOPERS.md
+5 -5
View File
@@ -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:
doc/INSTALL → docs/INSTALL
View File
doc/NEWS.md → docs/NEWS.md
View File
doc/TODO.md → docs/TODO.md
View File
doc/benchmark.sh → docs/benchmark.sh
View File
doc/pv.1 → docs/pv.1
View File
doc/pv.1.md → docs/pv.1.md
View File
src/include/config-aux.h
+1 -1
View File
@@ -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
src/include/options.h
+1 -1
View File
@@ -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
src/include/pv-internal.h
+1 -1
View File
@@ -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
src/include/pv.h
+1 -1
View File
@@ -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
src/main/debug.c
+1 -1
View File
@@ -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"
src/main/help.c
+1 -1
View File
@@ -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"
src/main/main.c
+1 -1
View File
@@ -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"
src/main/options.c
+1 -1
View File
@@ -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"
src/main/remote.c
+1 -1
View File
@@ -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"
src/main/version.c
+1 -1
View File
@@ -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"
src/pv/cursor.c
+1 -1
View File
@@ -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"
src/pv/display.c
+1 -1
View File
@@ -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"
src/pv/elapsedtime.c
+1 -1
View File
@@ -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"
src/pv/file.c
+1 -1
View File
@@ -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"
src/pv/loop.c
+1 -1
View File
@@ -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"
src/pv/number.c
+1 -1
View File
@@ -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"
src/pv/signal.c
+1 -1
View File
@@ -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"
src/pv/state.c
+1 -1
View File
@@ -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"
src/pv/string.c
+1 -1
View File
@@ -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"
src/pv/transfer.c
+1 -1
View File
@@ -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"
src/pv/watchpid.c
+1 -1
View File
@@ -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"