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

Miklos Vajna via cfe-commits cfe-commits at lists.llvm.org
Mon Aug 15 12:24:41 PDT 2016


Hi Eugene,

On Wed, Aug 10, 2016 at 10:00:50PM -0000, Eugene Zelenko via cfe-commits <cfe-commits at lists.llvm.org> 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&r1=278294&r2=278295&view=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=<filename>   - YAML file to store suggested fixes in.
> -    -extra-arg=<string>        - Additional argument to append to the compiler command line
> -    -extra-arg-before=<string> - Additional argument to prepend to the compiler command line
> +    -extra-arg=<string>        - Additional argument to append to the compiler command line.
> +    -extra-arg-before=<string> - Additional argument to prepend to the compiler command line.
>      -i                         - Overwrite edited <file>s.
>      -new-name=<string>         - The new name to change the symbol to.
>      -offset=<uint>             - Locates the symbol by offset as opposed to <line>:<column>.
> -    -p=<string>                - Build path
> +    -p=<string>                - 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&paste the output after a code
change.

Regards,

Miklos


More information about the cfe-commits mailing list