[PATCH] D47537: [clang-tools-extra] Cleanup documentation routine
This revision was automatically updated to reflect the committed changes.
Closed by commit rL336257: [clang-tools-extra] Cleanup documentation routine
(authored by omtcyfz, committed by ).
Herald added a subscriber: llvm-commits.
Changed prior to commit:
https://reviews.llvm.org/D47537?vs=150083&id=154086#toc
Repository:
rL LLVM
https://reviews.llvm.org/D47537
Files:
clang-tools-extra/trunk/docs/Doxyfile
clang-tools-extra/trunk/docs/doxygen.cfg.in
Index: clang-tools-extra/trunk/docs/doxygen.cfg.in
===
--- clang-tools-extra/trunk/docs/doxygen.cfg.in
+++ clang-tools-extra/trunk/docs/doxygen.cfg.in
@@ -743,15 +743,20 @@
# spaces.
# Note: If this tag is empty the current directory is searched.
-INPUT = \
- @abs_srcdir@/../clang-tidy \
- @abs_srcdir@/../clang-apply-replacements \
- @abs_srcdir@/../clang-query \
- @abs_srcdir@/../clang-rename \
- @abs_srcdir@/../modularize \
- @abs_srcdir@/../pp-trace \
- @abs_srcdir@/../tool-template \
- @abs_srcdir@/doxygen-mainpage.dox
+INPUT = \
+ @abs_srcdir@/../change-namespace \
+ @abs_srcdir@/../clang-apply-replacements \
+ @abs_srcdir@/../clang-doc \
+ @abs_srcdir@/../clang-move \
+ @abs_srcdir@/../clang-query \
+ @abs_srcdir@/../clang-reorder-fields \
+ @abs_srcdir@/../clang-tidy \
+ @abs_srcdir@/../clangd \
+ @abs_srcdir@/../include-fixer \
+ @abs_srcdir@/../modularize \
+ @abs_srcdir@/../pp-trace \
+ @abs_srcdir@/../tool-template \
+ @abs_srcdir@/doxygen-mainpage.dox
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Index: clang-tools-extra/trunk/docs/Doxyfile
===
--- clang-tools-extra/trunk/docs/Doxyfile
+++ clang-tools-extra/trunk/docs/Doxyfile
@@ -1,1808 +0,0 @@
-# Doxyfile 1.7.6.1
-
-# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project
-#
-# All text after a hash (#) is considered a comment and will be ignored
-# The format is:
-# TAG = value [value, ...]
-# For lists items can also be appended using:
-# TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (" ")
-
-#---
-# Project related configuration options
-#---
-
-# This tag specifies the encoding used for all characters in the config file
-# that follow. The default is UTF-8 which is also the encoding used for all
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
-# iconv built into libc) for the transcoding. See
-# http://www.gnu.org/software/libiconv for the list of possible encodings.
-
-DOXYFILE_ENCODING = UTF-8
-
-# The PROJECT_NAME tag is a single word (or sequence of words) that should
-# identify the project. Note that if you do not use Doxywizard you need
-# to put quotes around the project name if it contains spaces.
-
-PROJECT_NAME = clang-tools-extra
-
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
-# if some version control system is used.
-
-PROJECT_NUMBER =
-
-# Using the PROJECT_BRIEF tag one can provide an optional one line description
-# for a project that appears at the top of each page and should give viewer
-# a quick idea about the purpose of the project. Keep the description short.
-
-PROJECT_BRIEF =
-
-# With the PROJECT_LOGO tag one can specify an logo or icon that is
-# included in the documentation. The maximum height of the logo should not
-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
-# Doxygen will copy the logo to the output directory.
-
-PROJECT_LOGO =
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
-# where doxygen was started. If left blank the current directory will be used.
-
-# Same directory that Sphinx uses.
-OUTPUT_DIRECTORY = ./_build/
-
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
-# 4096 sub-directories (in 2 levels) under the output directory of
[PATCH] D47537: [clang-tools-extra] Cleanup documentation routine
ioeric accepted this revision. ioeric added a comment. This revision is now accepted and ready to land. lgtm. Thanks for doing this! https://reviews.llvm.org/D47537 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D47537: [clang-tools-extra] Cleanup documentation routine
omtcyfz added a comment. @ioeric makes sense to me, I have reverted the first part of the patch while only leaving the second part of the cleanup, which might still be useful. https://reviews.llvm.org/D47537 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D47537: [clang-tools-extra] Cleanup documentation routine
omtcyfz updated this revision to Diff 150083.
omtcyfz edited the summary of this revision.
omtcyfz added a comment.
Leave clang-rename docs in cfe-tools-extra repository, keep the second part of
the patch.
https://reviews.llvm.org/D47537
Files:
clang-tools-extra/docs/Doxyfile
clang-tools-extra/docs/doxygen.cfg.in
Index: clang-tools-extra/docs/doxygen.cfg.in
===
--- clang-tools-extra/docs/doxygen.cfg.in
+++ clang-tools-extra/docs/doxygen.cfg.in
@@ -743,14 +743,20 @@
# spaces.
# Note: If this tag is empty the current directory is searched.
-INPUT = \
- @abs_srcdir@/../clang-tidy \
- @abs_srcdir@/../clang-apply-replacements \
- @abs_srcdir@/../clang-query \
- @abs_srcdir@/../modularize \
- @abs_srcdir@/../pp-trace \
- @abs_srcdir@/../tool-template \
- @abs_srcdir@/doxygen-mainpage.dox
+INPUT = \
+ @abs_srcdir@/../change-namespace \
+ @abs_srcdir@/../clang-apply-replacements \
+ @abs_srcdir@/../clang-doc \
+ @abs_srcdir@/../clang-move \
+ @abs_srcdir@/../clang-query \
+ @abs_srcdir@/../clang-reorder-fields \
+ @abs_srcdir@/../clang-tidy \
+ @abs_srcdir@/../clangd \
+ @abs_srcdir@/../include-fixer \
+ @abs_srcdir@/../modularize \
+ @abs_srcdir@/../pp-trace \
+ @abs_srcdir@/../tool-template \
+ @abs_srcdir@/doxygen-mainpage.dox
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Index: clang-tools-extra/docs/Doxyfile
===
--- clang-tools-extra/docs/Doxyfile
+++ /dev/null
@@ -1,1808 +0,0 @@
-# Doxyfile 1.7.6.1
-
-# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project
-#
-# All text after a hash (#) is considered a comment and will be ignored
-# The format is:
-# TAG = value [value, ...]
-# For lists items can also be appended using:
-# TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (" ")
-
-#---
-# Project related configuration options
-#---
-
-# This tag specifies the encoding used for all characters in the config file
-# that follow. The default is UTF-8 which is also the encoding used for all
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
-# iconv built into libc) for the transcoding. See
-# http://www.gnu.org/software/libiconv for the list of possible encodings.
-
-DOXYFILE_ENCODING = UTF-8
-
-# The PROJECT_NAME tag is a single word (or sequence of words) that should
-# identify the project. Note that if you do not use Doxywizard you need
-# to put quotes around the project name if it contains spaces.
-
-PROJECT_NAME = clang-tools-extra
-
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
-# if some version control system is used.
-
-PROJECT_NUMBER =
-
-# Using the PROJECT_BRIEF tag one can provide an optional one line description
-# for a project that appears at the top of each page and should give viewer
-# a quick idea about the purpose of the project. Keep the description short.
-
-PROJECT_BRIEF =
-
-# With the PROJECT_LOGO tag one can specify an logo or icon that is
-# included in the documentation. The maximum height of the logo should not
-# exceed 55 pixels and the maximum width should not exceed 200 pixels.
-# Doxygen will copy the logo to the output directory.
-
-PROJECT_LOGO =
-
-# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
-# base path where the generated documentation will be put.
-# If a relative path is entered, it will be relative to the location
-# where doxygen was started. If left blank the current directory will be used.
-
-# Same directory that Sphinx uses.
-OUTPUT_DIRECTORY = ./_build/
-
-# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create
-# 4096 sub-directories (in 2 levels) under the output directory of each output
-# format and will distribute the generated files over these directories.
-# Enabling this option can be useful when feeding doxygen a huge amount of
-# source files, where putting all generated files in the same directory would
-# otherwise c
[PATCH] D47537: [clang-tools-extra] Cleanup documentation routine
ioeric added inline comments. Comment at: clang-tools-extra/docs/index.rst:27 pp-trace - clang-rename clangd It seems that the clang-rename tool is still in the extra repository. I think we should probably "advertise" `clang-rename` as part of clang-refactor in the future. That said, we might want to wait until we have proper documentation for clang-refactor in clang. WDYT? https://reviews.llvm.org/D47537 ___ cfe-commits mailing list cfe-commits@lists.llvm.org http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D47537: [clang-tools-extra] Cleanup documentation routine
omtcyfz updated this revision to Diff 149138.
omtcyfz retitled this revision from "[clang-rename] Move clang-rename
documentation to Clang repository" to "[clang-tools-extra] Cleanup
documentation routine".
omtcyfz edited the summary of this revision.
omtcyfz added a comment.
Herald added a subscriber: ilya-biryukov.
I also noticed that some directories in clang-tools-extra are not present in
Doxygen configuration file and hence these directories are not processed. I
removed irrelevant Doxygen configuration file (which seems to be abandoned and
unused) and updated the input list.
https://reviews.llvm.org/D47537
Files:
clang-tools-extra/docs/Doxyfile
clang-tools-extra/docs/clang-rename.rst
clang-tools-extra/docs/doxygen.cfg.in
clang-tools-extra/docs/index.rst
clang/docs/ClangRename.rst
clang/docs/index.rst
Index: clang/docs/index.rst
===
--- clang/docs/index.rst
+++ clang/docs/index.rst
@@ -74,6 +74,7 @@
ClangCheck
ClangFormat
ClangFormatStyleOptions
+ ClangRename
Design Documents
Index: clang/docs/ClangRename.rst
===
--- clang/docs/ClangRename.rst
+++ clang/docs/ClangRename.rst
@@ -1,5 +1,5 @@
-Clang-Rename
+ClangRename
.. contents::
Index: clang-tools-extra/docs/index.rst
===
--- clang-tools-extra/docs/index.rst
+++ clang-tools-extra/docs/index.rst
@@ -24,7 +24,6 @@
include-fixer
modularize
pp-trace
- clang-rename
clangd
clang-doc
Index: clang-tools-extra/docs/doxygen.cfg.in
===
--- clang-tools-extra/docs/doxygen.cfg.in
+++ clang-tools-extra/docs/doxygen.cfg.in
@@ -743,15 +743,20 @@
# spaces.
# Note: If this tag is empty the current directory is searched.
-INPUT = \
- @abs_srcdir@/../clang-tidy \
- @abs_srcdir@/../clang-apply-replacements \
- @abs_srcdir@/../clang-query \
- @abs_srcdir@/../clang-rename \
- @abs_srcdir@/../modularize \
- @abs_srcdir@/../pp-trace \
- @abs_srcdir@/../tool-template \
- @abs_srcdir@/doxygen-mainpage.dox
+INPUT = \
+ @abs_srcdir@/../change-namespace \
+ @abs_srcdir@/../clang-apply-replacements \
+ @abs_srcdir@/../clang-doc \
+ @abs_srcdir@/../clang-move \
+ @abs_srcdir@/../clang-query \
+ @abs_srcdir@/../clang-reorder-fields \
+ @abs_srcdir@/../clang-tidy \
+ @abs_srcdir@/../clangd \
+ @abs_srcdir@/../include-fixer \
+ @abs_srcdir@/../modularize \
+ @abs_srcdir@/../pp-trace \
+ @abs_srcdir@/../tool-template \
+ @abs_srcdir@/doxygen-mainpage.dox
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
Index: clang-tools-extra/docs/Doxyfile
===
--- clang-tools-extra/docs/Doxyfile
+++ /dev/null
@@ -1,1808 +0,0 @@
-# Doxyfile 1.7.6.1
-
-# This file describes the settings to be used by the documentation system
-# doxygen (www.doxygen.org) for a project
-#
-# All text after a hash (#) is considered a comment and will be ignored
-# The format is:
-# TAG = value [value, ...]
-# For lists items can also be appended using:
-# TAG += value [value, ...]
-# Values that contain spaces should be placed between quotes (" ")
-
-#---
-# Project related configuration options
-#---
-
-# This tag specifies the encoding used for all characters in the config file
-# that follow. The default is UTF-8 which is also the encoding used for all
-# text before the first occurrence of this tag. Doxygen uses libiconv (or the
-# iconv built into libc) for the transcoding. See
-# http://www.gnu.org/software/libiconv for the list of possible encodings.
-
-DOXYFILE_ENCODING = UTF-8
-
-# The PROJECT_NAME tag is a single word (or sequence of words) that should
-# identify the project. Note that if you do not use Doxywizard you need
-# to put quotes around the project name if it contains spaces.
-
-PROJECT_NAME = clang-tools-extra
-
-# The PROJECT_NUMBER tag can be used to enter a project or revision number.
-# This could be handy for archiving the generated documentation or
-#
