Re: [clang-tools-extra] r278295 - [Documentation] Improve consistency.

[Eugene Zelenko via cfe-commits]

Hi, Miklos!

Sorry, I was not aware about documentation source.

But I think will be good idea to improve punctuation consistency in tool itself.

Eugene.

On Mon, Aug 15, 2016 at 12:24 PM, Miklos Vajna  wrote:
> Hi Eugene,
>
> On Wed, Aug 10, 2016 at 10:00:50PM -, Eugene Zelenko via cfe-commits 
>  wrote:
>> Modified: clang-tools-extra/trunk/docs/clang-rename.rst
>> URL: 
>> http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-rename.rst?rev=278295=278294=278295=diff
>> ==
>> --- clang-tools-extra/trunk/docs/clang-rename.rst (original)
>> +++ clang-tools-extra/trunk/docs/clang-rename.rst Wed Aug 10 17:00:49 2016
>> @@ -70,7 +70,7 @@ Alternatively, old name / new name pairs
>>...
>>
>>
>> -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.
>
> This is the output of the commandline tool. Is it wise to modify the
> documentation, even if the tool's output stays the same? I fear it'll be
> reverted implicitly next time we copy the output after a code
> change.
>
> Regards,
>
> Miklos
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Re: [clang-tools-extra] r278295 - [Documentation] Improve consistency.

[Miklos Vajna via cfe-commits]

Hi Eugene,

On Wed, Aug 10, 2016 at 10:00:50PM -, Eugene Zelenko via cfe-commits 
 wrote:
> Modified: clang-tools-extra/trunk/docs/clang-rename.rst
> URL: 
> http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-rename.rst?rev=278295=278294=278295=diff
> ==
> --- clang-tools-extra/trunk/docs/clang-rename.rst (original)
> +++ clang-tools-extra/trunk/docs/clang-rename.rst Wed Aug 10 17:00:49 2016
> @@ -70,7 +70,7 @@ Alternatively, old name / new name pairs
>...
>  
>  
> -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.

This is the output of the commandline tool. Is it wise to modify the
documentation, even if the tool's output stays the same? I fear it'll be
reverted implicitly next time we copy the output after a code
change.

Regards,

Miklos
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

[clang-tools-extra] r278295 - [Documentation] Improve consistency.

[Eugene Zelenko via cfe-commits]

Author: eugenezelenko
Date: Wed Aug 10 17:00:49 2016
New Revision: 278295

URL: http://llvm.org/viewvc/llvm-project?rev=278295=rev
Log:
[Documentation] Improve consistency.

Mention Clang-rename Emacs integration in release notes.

Modified:
clang-tools-extra/trunk/docs/ReleaseNotes.rst
clang-tools-extra/trunk/docs/clang-rename.rst
clang-tools-extra/trunk/docs/include-fixer.rst

Modified: clang-tools-extra/trunk/docs/ReleaseNotes.rst
URL: 
http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/ReleaseNotes.rst?rev=278295=278294=278295=diff
==
--- clang-tools-extra/trunk/docs/ReleaseNotes.rst (original)
+++ clang-tools-extra/trunk/docs/ReleaseNotes.rst Wed Aug 10 17:00:49 2016
@@ -54,7 +54,7 @@ The improvements are...
 Improvements to clang-rename
 
 
-The improvements are...
+- Emacs integration was added.
 
 Improvements to clang-tidy
 --

Modified: clang-tools-extra/trunk/docs/clang-rename.rst
URL: 
http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-rename.rst?rev=278295=278294=278295=diff
==
--- clang-tools-extra/trunk/docs/clang-rename.rst (original)
+++ clang-tools-extra/trunk/docs/clang-rename.rst Wed Aug 10 17:00:49 2016
@@ -70,7 +70,7 @@ Alternatively, old name / new name pairs
   ...
 
 
-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

Modified: clang-tools-extra/trunk/docs/include-fixer.rst
URL: 
http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/include-fixer.rst?rev=278295=278294=278295=diff
==
--- clang-tools-extra/trunk/docs/include-fixer.rst (original)
+++ clang-tools-extra/trunk/docs/include-fixer.rst Wed Aug 10 17:00:49 2016
@@ -105,7 +105,7 @@ See ``clang-include-fixer.el`` for more
 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


___
cfe-commits