Quuxplusone / LLVMBugzillaTest

0 stars 0 forks source link

clang-apply-replacements Undocumented requirement for Inputs directory #33086

Open Quuxplusone opened 6 years ago

Quuxplusone commented 6 years ago
Bugzilla Link PR34114
Status NEW
Importance P normal
Reported by JVApen (jvapen@gmail.com)
Reported on 2017-08-08 00:47:17 -0700
Last modified on 2019-05-02 01:16:15 -0700
Version unspecified
Hardware PC Windows NT
CC jvapen@gmail.com, klimek@google.com
Fixed by commit(s)
Attachments
Blocks
Blocked by
See also
While experimenting with clang-tidy and clang-apply-replacements,
we were unable to deduce from the little documentation available (--help
option) that the correct way of using clang-apply-replacements is to do the
following:

 - Go to the root of the project
 - Create directory called Inputs
 - Store the files as <filename>.yaml in the Inputs directory
 - Run: clang-apply-replacements .

The only way we were able to deduce this was by understanding the change of
invalid-files.cpp at https://reviews.llvm.org/D35194

Would it be possible to extend the documentation of this tool (or create a doc-
page similar to clang-tidy) which explains the usage?
Quuxplusone commented 5 years ago

Correcting 'enhancement' to 'normal' issue. This ain't a feature request.