[PATCH] D108765: [docs] Fix documentation of clang-format BasedOnStyle type

Ludovic Jozeau via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Aug 26 08:30:17 PDT 2021


FederAndInk added a comment.

Thank you for your explanations, I understand now.

But as I look into `clang/docs/tools/dump_format_style.py` I see that it does not entirely generate `clang/docs/ClangFormatStyleOptions.rst` it replaces the lines between `{START,END}_FORMAT_STYLE_OPTIONS`

I understand your point, but as of now, the inconsistency comes from the part that is not auto-generated, are you suggesting editing `dump_format_style.py` to have simpler types such as `string`? Then how should we replace `std::vector`? Something like `Type[]` e.g. `string[]`?

Or maybe we should first include `BasedOnStyle` into `dump_format_style.py`. Then take care of how to render types?

What do you suggest? I am genuinely asking, as I really don't know what would be the best way to do things. Maybe we should include other people? I don't really know who to add as reviewers for that, but I think, the way to show types, should be discussed?

As for detailing `RawStringFormat`, it wasn't the purpose of this patch, and maybe it should have its own?


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D108765/new/

https://reviews.llvm.org/D108765



More information about the cfe-commits mailing list