From 981206fa8c8f7e1c60213774bd01116a900abd83 Mon Sep 17 00:00:00 2001 From: sangelovic Date: Thu, 25 Apr 2019 23:48:11 +0200 Subject: [PATCH] Rename doc subdirectory to docs for higher consistency with OSS standards --- CMakeLists.txt | 2 +- README.md | 8 ++++---- {doc => docs}/CMakeLists.txt | 0 {doc => docs}/Doxyfile.in | 0 {doc => docs}/sdbus-c++-class-diagram.png | Bin {doc => docs}/sdbus-c++-class-diagram.uml | 0 {doc => docs}/systemd-dbus-config.md | 0 {doc => docs}/using-sdbus-c++.md | 0 8 files changed, 5 insertions(+), 5 deletions(-) rename {doc => docs}/CMakeLists.txt (100%) rename {doc => docs}/Doxyfile.in (100%) rename {doc => docs}/sdbus-c++-class-diagram.png (100%) rename {doc => docs}/sdbus-c++-class-diagram.uml (100%) rename {doc => docs}/systemd-dbus-config.md (100%) rename {doc => docs}/using-sdbus-c++.md (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 7e8277d..8b1bf3f 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -142,7 +142,7 @@ option(BUILD_DOC "Build documentation for sdbus-c++" ON) option(BUILD_DOXYGEN_DOC "Build doxygen documentation for sdbus-c++ API" OFF) if(BUILD_DOC) - add_subdirectory("${CMAKE_SOURCE_DIR}/doc") + add_subdirectory("${CMAKE_SOURCE_DIR}/docs") install(FILES README README.md NEWS COPYING ChangeLog AUTHORS DESTINATION ${CMAKE_INSTALL_DOCDIR}) endif() diff --git a/README.md b/README.md index fa0de22..f243149 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ Dependencies ------------ * `C++17` - the library uses C++17 `std::uncaught_exceptions()` feature. When building sdbus-c++ manually, make sure you use a compiler that supports that feature (gcc >= 6, clang >= 3.7) -* `libsystemd` - systemd library containing sd-bus implementation. This library is part of systemd. Systemd at least v236 is needed. (Non-systemd environments are also supported, see the [tutorial](doc/using-sdbus-c++.md#solving-libsystemd-dependency) for more information.) +* `libsystemd` - systemd library containing sd-bus implementation. This library is part of systemd. Systemd at least v236 is needed. (Non-systemd environments are also supported, see the [tutorial](docs/using-sdbus-c++.md#solving-libsystemd-dependency) for more information.) * `googletest` - google unit testing framework, only necessary when building tests, will be downloaded and built automatically. Licensing @@ -63,10 +63,10 @@ The library is distributed under LGPLv2.1 license. References/documentation ------------------------ -* [D-Bus Specification](https://dbus.freedesktop.org/doc/dbus-specification.html) +* [D-Bus Specification](https://dbus.freedesktop.org/docs/dbus-specification.html) * [sd-bus Overview](http://0pointer.net/blog/the-new-sd-bus-api-of-systemd.html) -* [Tutorial: Using sdbus-c++](doc/using-sdbus-c++.md) -* [Systemd and dbus configuration](doc/systemd-dbus-config.md) +* [Tutorial: Using sdbus-c++](docs/using-sdbus-c++.md) +* [Systemd and dbus configuration](docs/systemd-dbus-config.md) Contributing ------------ diff --git a/doc/CMakeLists.txt b/docs/CMakeLists.txt similarity index 100% rename from doc/CMakeLists.txt rename to docs/CMakeLists.txt diff --git a/doc/Doxyfile.in b/docs/Doxyfile.in similarity index 100% rename from doc/Doxyfile.in rename to docs/Doxyfile.in diff --git a/doc/sdbus-c++-class-diagram.png b/docs/sdbus-c++-class-diagram.png similarity index 100% rename from doc/sdbus-c++-class-diagram.png rename to docs/sdbus-c++-class-diagram.png diff --git a/doc/sdbus-c++-class-diagram.uml b/docs/sdbus-c++-class-diagram.uml similarity index 100% rename from doc/sdbus-c++-class-diagram.uml rename to docs/sdbus-c++-class-diagram.uml diff --git a/doc/systemd-dbus-config.md b/docs/systemd-dbus-config.md similarity index 100% rename from doc/systemd-dbus-config.md rename to docs/systemd-dbus-config.md diff --git a/doc/using-sdbus-c++.md b/docs/using-sdbus-c++.md similarity index 100% rename from doc/using-sdbus-c++.md rename to docs/using-sdbus-c++.md