Skip to content

Commit ab50efe

Browse files
authored
Merge pull request #2055 from joto/docs-to-man
Rename "docs" directory to "man"
2 parents b9b1638 + a29a086 commit ab50efe

File tree

12 files changed

+9
-19
lines changed

12 files changed

+9
-19
lines changed

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ endif()
356356
# Man page
357357
#############################################################
358358

359-
add_subdirectory(docs)
359+
add_subdirectory(man)
360360

361361
#############################################################
362362
# Install

CONTRIBUTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ convention](https://www.doxygen.nl/manual/docblocks.html) using backslashes
5555

5656
## Documentation
5757

58-
User documentation is available on [the website](https://osm2pgsql.org/), some
59-
is stored in `docs/`. Pages on the OpenStreetMap wiki are known to be
60-
unreliable and outdated.
58+
User documentation is available on [the website](https://osm2pgsql.org/). The
59+
source of the web page is in its own repository
60+
(https://github.com/openstreetmap/osm2pgsql-website).
6161

62-
The man pages for [osm2pgsql](docs/osm2pgsql.1) and
63-
[osm2pgsql-replication](docs/osm2pgsql-replication.1) can be built from source
62+
The man pages for [osm2pgsql](man/osm2pgsql.1) and
63+
[osm2pgsql-replication](man/osm2pgsql-replication.1) can be built from source
6464
with `make man`.
6565

6666
They need pandoc and argparse-manpage for the conversion. These tools can be
@@ -207,7 +207,7 @@ the report.
207207

208208
* Decide on a new version. (See [semantic versioning](https://semver.org/).)
209209
* Update version in [CMakeLists.txt](CMakeLists.txt), look for `project` function.
210-
* Build man page (`make man`) and copy it to `docs/osm2pgsql.1`.
210+
* Build man page (`make man`) and copy it to `man/osm2pgsql.1`.
211211
* Tag release with release notes in commit message and upload the tag to Github.
212212
* Fill out release notes on Github.
213213
* Copy Windows binaries and source tarball to osm2pgsql.org.

docs/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)