From 6c7f0093d2a325d262aefc8652ff86fe4030e141 Mon Sep 17 00:00:00 2001 From: Florent Pruvost <florent.pruvost@inria.fr> Date: Fri, 25 Aug 2017 11:11:48 +0200 Subject: [PATCH] docs/ directory should be called doc/ for consistency --- CMakeLists.txt | 12 ++++++------ {docs => doc}/CMakeLists.txt | 0 {docs => doc}/doxygen/CMakeLists.txt | 0 {docs => doc}/doxygen/README.org | 0 {docs => doc}/doxygen/conf-dev-quark.dox.in | 0 {docs => doc}/doxygen/conf-dev-starpu.dox.in | 0 {docs => doc}/doxygen/conf-usr-quark.dox.in | 0 {docs => doc}/doxygen/conf-usr-starpu.dox.in | 0 {docs => doc}/doxygen/groups-dev.dox | 0 {docs => doc}/doxygen/groups-usr.dox | 0 {docs => doc}/doxygen/main.dox | 0 {docs => doc}/texinfo/CMakeLists.txt | 0 {docs => doc}/texinfo/chapters/configuration.texi | 0 {docs => doc}/texinfo/chapters/installing.texi | 0 {docs => doc}/texinfo/chapters/introduction.texi | 0 {docs => doc}/texinfo/chapters/using.texi | 0 {docs => doc}/texinfo/figures/morse_header.png | Bin {docs => doc}/texinfo/figures/potri_async.png | Bin {docs => doc}/texinfo/figures/tile_layout.jpg | Bin {docs => doc}/texinfo/figures/tile_layout.pdf | Bin {docs => doc}/texinfo/figures/tile_lu.jpg | Bin {docs => doc}/texinfo/figures/tile_lu.pdf | Bin {docs => doc}/texinfo/figures/trace_qr.jpg | Bin {docs => doc}/texinfo/figures/trace_qr.pdf | Bin {docs => doc}/texinfo/morse.css | 0 {docs => doc}/texinfo/users_guide.texi.in | 0 {docs => doc}/texinfo/version.texi.in | 0 27 files changed, 6 insertions(+), 6 deletions(-) rename {docs => doc}/CMakeLists.txt (100%) rename {docs => doc}/doxygen/CMakeLists.txt (100%) rename {docs => doc}/doxygen/README.org (100%) rename {docs => doc}/doxygen/conf-dev-quark.dox.in (100%) rename {docs => doc}/doxygen/conf-dev-starpu.dox.in (100%) rename {docs => doc}/doxygen/conf-usr-quark.dox.in (100%) rename {docs => doc}/doxygen/conf-usr-starpu.dox.in (100%) rename {docs => doc}/doxygen/groups-dev.dox (100%) rename {docs => doc}/doxygen/groups-usr.dox (100%) rename {docs => doc}/doxygen/main.dox (100%) rename {docs => doc}/texinfo/CMakeLists.txt (100%) rename {docs => doc}/texinfo/chapters/configuration.texi (100%) rename {docs => doc}/texinfo/chapters/installing.texi (100%) rename {docs => doc}/texinfo/chapters/introduction.texi (100%) rename {docs => doc}/texinfo/chapters/using.texi (100%) rename {docs => doc}/texinfo/figures/morse_header.png (100%) rename {docs => doc}/texinfo/figures/potri_async.png (100%) rename {docs => doc}/texinfo/figures/tile_layout.jpg (100%) rename {docs => doc}/texinfo/figures/tile_layout.pdf (100%) rename {docs => doc}/texinfo/figures/tile_lu.jpg (100%) rename {docs => doc}/texinfo/figures/tile_lu.pdf (100%) rename {docs => doc}/texinfo/figures/trace_qr.jpg (100%) rename {docs => doc}/texinfo/figures/trace_qr.pdf (100%) rename {docs => doc}/texinfo/morse.css (100%) rename {docs => doc}/texinfo/users_guide.texi.in (100%) rename {docs => doc}/texinfo/version.texi.in (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index f7e4ae355..609d5c1bd 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -205,9 +205,9 @@ endif() # Options to enable/disable testings and timings # ---------------------------------------------- -option(CHAMELEON_ENABLE_DOCS "Enable documentation build" OFF) -if (CHAMELEON_ENABLE_DOCS) - message("-- ${BoldGreen}CHAMELEON_ENABLE_DOCS is set to ON, turn it OFF to avoid building docs${ColourReset}") +option(CHAMELEON_ENABLE_DOC "Enable documentation build" OFF) +if (CHAMELEON_ENABLE_DOC) + message("-- ${BoldGreen}CHAMELEON_ENABLE_DOC is set to ON, turn it OFF to avoid building docs${ColourReset}") endif() option(CHAMELEON_ENABLE_EXAMPLE "Enable examples build" ON) if (CHAMELEON_ENABLE_EXAMPLE) @@ -1084,10 +1084,10 @@ endif(CHAMELEON_ENABLE_TIMING) # Documentation # ################# -if(CHAMELEON_ENABLE_DOCS) - add_subdirectory(docs) +if(CHAMELEON_ENABLE_DOC) + add_subdirectory(doc) if (DOXYGEN_EXECUTABLE AND MAKEINFO_COMPILER AND TEXI2DVI_COMPILER AND TEX_COMPILER) - add_custom_target(docs ALL DEPENDS doxygen-out doc-info-users_guide doc-html-users_guide doc-pdf-users_guide) + add_custom_target(doc ALL DEPENDS doxygen-out doc-info-users_guide doc-html-users_guide doc-pdf-users_guide) endif() endif() #------------------------------------------------------------------------------ diff --git a/docs/CMakeLists.txt b/doc/CMakeLists.txt similarity index 100% rename from docs/CMakeLists.txt rename to doc/CMakeLists.txt diff --git a/docs/doxygen/CMakeLists.txt b/doc/doxygen/CMakeLists.txt similarity index 100% rename from docs/doxygen/CMakeLists.txt rename to doc/doxygen/CMakeLists.txt diff --git a/docs/doxygen/README.org b/doc/doxygen/README.org similarity index 100% rename from docs/doxygen/README.org rename to doc/doxygen/README.org diff --git a/docs/doxygen/conf-dev-quark.dox.in b/doc/doxygen/conf-dev-quark.dox.in similarity index 100% rename from docs/doxygen/conf-dev-quark.dox.in rename to doc/doxygen/conf-dev-quark.dox.in diff --git a/docs/doxygen/conf-dev-starpu.dox.in b/doc/doxygen/conf-dev-starpu.dox.in similarity index 100% rename from docs/doxygen/conf-dev-starpu.dox.in rename to doc/doxygen/conf-dev-starpu.dox.in diff --git a/docs/doxygen/conf-usr-quark.dox.in b/doc/doxygen/conf-usr-quark.dox.in similarity index 100% rename from docs/doxygen/conf-usr-quark.dox.in rename to doc/doxygen/conf-usr-quark.dox.in diff --git a/docs/doxygen/conf-usr-starpu.dox.in b/doc/doxygen/conf-usr-starpu.dox.in similarity index 100% rename from docs/doxygen/conf-usr-starpu.dox.in rename to doc/doxygen/conf-usr-starpu.dox.in diff --git a/docs/doxygen/groups-dev.dox b/doc/doxygen/groups-dev.dox similarity index 100% rename from docs/doxygen/groups-dev.dox rename to doc/doxygen/groups-dev.dox diff --git a/docs/doxygen/groups-usr.dox b/doc/doxygen/groups-usr.dox similarity index 100% rename from docs/doxygen/groups-usr.dox rename to doc/doxygen/groups-usr.dox diff --git a/docs/doxygen/main.dox b/doc/doxygen/main.dox similarity index 100% rename from docs/doxygen/main.dox rename to doc/doxygen/main.dox diff --git a/docs/texinfo/CMakeLists.txt b/doc/texinfo/CMakeLists.txt similarity index 100% rename from docs/texinfo/CMakeLists.txt rename to doc/texinfo/CMakeLists.txt diff --git a/docs/texinfo/chapters/configuration.texi b/doc/texinfo/chapters/configuration.texi similarity index 100% rename from docs/texinfo/chapters/configuration.texi rename to doc/texinfo/chapters/configuration.texi diff --git a/docs/texinfo/chapters/installing.texi b/doc/texinfo/chapters/installing.texi similarity index 100% rename from docs/texinfo/chapters/installing.texi rename to doc/texinfo/chapters/installing.texi diff --git a/docs/texinfo/chapters/introduction.texi b/doc/texinfo/chapters/introduction.texi similarity index 100% rename from docs/texinfo/chapters/introduction.texi rename to doc/texinfo/chapters/introduction.texi diff --git a/docs/texinfo/chapters/using.texi b/doc/texinfo/chapters/using.texi similarity index 100% rename from docs/texinfo/chapters/using.texi rename to doc/texinfo/chapters/using.texi diff --git a/docs/texinfo/figures/morse_header.png b/doc/texinfo/figures/morse_header.png similarity index 100% rename from docs/texinfo/figures/morse_header.png rename to doc/texinfo/figures/morse_header.png diff --git a/docs/texinfo/figures/potri_async.png b/doc/texinfo/figures/potri_async.png similarity index 100% rename from docs/texinfo/figures/potri_async.png rename to doc/texinfo/figures/potri_async.png diff --git a/docs/texinfo/figures/tile_layout.jpg b/doc/texinfo/figures/tile_layout.jpg similarity index 100% rename from docs/texinfo/figures/tile_layout.jpg rename to doc/texinfo/figures/tile_layout.jpg diff --git a/docs/texinfo/figures/tile_layout.pdf b/doc/texinfo/figures/tile_layout.pdf similarity index 100% rename from docs/texinfo/figures/tile_layout.pdf rename to doc/texinfo/figures/tile_layout.pdf diff --git a/docs/texinfo/figures/tile_lu.jpg b/doc/texinfo/figures/tile_lu.jpg similarity index 100% rename from docs/texinfo/figures/tile_lu.jpg rename to doc/texinfo/figures/tile_lu.jpg diff --git a/docs/texinfo/figures/tile_lu.pdf b/doc/texinfo/figures/tile_lu.pdf similarity index 100% rename from docs/texinfo/figures/tile_lu.pdf rename to doc/texinfo/figures/tile_lu.pdf diff --git a/docs/texinfo/figures/trace_qr.jpg b/doc/texinfo/figures/trace_qr.jpg similarity index 100% rename from docs/texinfo/figures/trace_qr.jpg rename to doc/texinfo/figures/trace_qr.jpg diff --git a/docs/texinfo/figures/trace_qr.pdf b/doc/texinfo/figures/trace_qr.pdf similarity index 100% rename from docs/texinfo/figures/trace_qr.pdf rename to doc/texinfo/figures/trace_qr.pdf diff --git a/docs/texinfo/morse.css b/doc/texinfo/morse.css similarity index 100% rename from docs/texinfo/morse.css rename to doc/texinfo/morse.css diff --git a/docs/texinfo/users_guide.texi.in b/doc/texinfo/users_guide.texi.in similarity index 100% rename from docs/texinfo/users_guide.texi.in rename to doc/texinfo/users_guide.texi.in diff --git a/docs/texinfo/version.texi.in b/doc/texinfo/version.texi.in similarity index 100% rename from docs/texinfo/version.texi.in rename to doc/texinfo/version.texi.in -- GitLab