From 3ed5011d519059f35224bab883c51728f5330742 Mon Sep 17 00:00:00 2001 From: Eugene Zelenko Date: Wed, 10 Aug 2016 22:00:49 +0000 Subject: [PATCH] [Documentation] Improve consistency. Mention Clang-rename Emacs integration in release notes. llvm-svn: 278295 --- clang-tools-extra/docs/ReleaseNotes.rst | 2 +- clang-tools-extra/docs/clang-rename.rst | 20 ++++++++++---------- clang-tools-extra/docs/include-fixer.rst | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index 0a8d12d..eaf2e17 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -54,7 +54,7 @@ The improvements are... Improvements to clang-rename ---------------------------- -The improvements are... +- Emacs integration was added. Improvements to clang-tidy -------------------------- diff --git a/clang-tools-extra/docs/clang-rename.rst b/clang-tools-extra/docs/clang-rename.rst index 382998f..8e5aba6 100644 --- a/clang-tools-extra/docs/clang-rename.rst +++ b/clang-tools-extra/docs/clang-rename.rst @@ -70,7 +70,7 @@ Alternatively, old name / new name pairs can be put into a YAML file: ... -That way you can avoid spelling out all the names as commandline arguments: +That way you can avoid spelling out all the names as command line arguments: .. code-block:: console @@ -122,12 +122,12 @@ The YAML file also supports offsets: clang-rename rename-at options: -export-fixes= - YAML file to store suggested fixes in. - -extra-arg= - Additional argument to append to the compiler command line - -extra-arg-before= - Additional argument to prepend to the compiler command line + -extra-arg= - Additional argument to append to the compiler command line. + -extra-arg-before= - Additional argument to prepend to the compiler command line. -i - Overwrite edited s. -new-name= - The new name to change the symbol to. -offset= - Locates the symbol by offset as opposed to :. - -p= - Build path + -p= - Build path. -pl - Print the locations affected by renaming to stderr. -pn - Print the found symbol's name prior to renaming to stderr. @@ -144,21 +144,21 @@ The YAML file also supports offsets: Generic Options: - -help - Display available options (-help-hidden for more) - -help-list - Display list of available options (-help-list-hidden for more) - -version - Display the version of this program + -help - Display available options (-help-hidden for more). + -help-list - Display list of available options (-help-list-hidden for more). + -version - Display the version of this program. clang-rename rename-all options: -export-fixes= - YAML file to store suggested fixes in. - -extra-arg= - Additional argument to append to the compiler command line - -extra-arg-before= - Additional argument to prepend to the compiler command line + -extra-arg= - Additional argument to append to the compiler command line. + -extra-arg-before= - Additional argument to prepend to the compiler command line. -i - Overwrite edited s. -input= - YAML file to load oldname-newname pairs from. -new-name= - The new name to change the symbol to. -offset= - Locates the symbol by offset as opposed to :. -old-name= - The fully qualified name of the symbol, if -offset is not used. - -p= - Build path + -p= - Build path. Vim Integration diff --git a/clang-tools-extra/docs/include-fixer.rst b/clang-tools-extra/docs/include-fixer.rst index ba1c69f..3d31200 100644 --- a/clang-tools-extra/docs/include-fixer.rst +++ b/clang-tools-extra/docs/include-fixer.rst @@ -105,7 +105,7 @@ See ``clang-include-fixer.el`` for more details. How it Works ============ -To get the most information out of clang at parse time, +To get the most information out of Clang at parse time, :program:`clang-include-fixer` runs in tandem with the parse and receives callbacks from Clang's semantic analysis. In particular it reuses the existing support for typo corrections. Whenever Clang tries to correct a potential typo -- 2.7.4