aaron.ballman added a comment.

In D133349#3771780 <https://reviews.llvm.org/D133349#3771780>, 
@serge-sans-paille wrote:

> @aaron.ballman this is just a patch to start a discussion: We already have 
> the cmake rule to generate this file, so removing it from tree actually 
> doesn't break compilation. So I'm wondering why and if we should keep it 
> checked in? Removing it would make it less likely for simple minded people 
> like me to edit it (without reading the header warning)

I think it's a good idea to remove it from the tree. We already removed the 
attribute and diagnostic references, both of which are generated files as well. 
When I remove the command line reference locally and do a non-cmake-based build 
(the old `make html`-style of doing local builds) and I get very reasonable 
behavior:

  F:\source\llvm-project\clang\docs>make html
  Running Sphinx v5.0.1
  loading pickled environment... done
  building [mo]: targets for 0 po files that are out of date
  building [html]: targets for 6 source files that are out of date
  updating environment: 0 added, 10 changed, 1 removed
  reading sources... [100%] index
  F:\source\llvm-project\clang\docs\index.rst:16: WARNING: toctree contains 
reference to nonexisting document 'ClangCommandLineReference'
  F:\source\llvm-project\clang\docs\index.rst:16: WARNING: toctree contains 
reference to nonexisting document 'AttributeReference'
  F:\source\llvm-project\clang\docs\index.rst:16: WARNING: toctree contains 
reference to nonexisting document 'DiagnosticsReference'
  looking for now-outdated files... none found
  pickling environment... done
  checking consistency... done
  preparing documents... done
  writing output... [100%] index
  generating indices... genindex done
  writing additional pages... search done
  copying static files... done
  copying extra files... done
  dumping search index in English (code: en)... done
  dumping object inventory... done
  build succeeded, 3 warnings.
  
  The HTML pages are in _build\html.
  
  Build finished. The HTML pages are in _build/html.

Those three links are broken in the local docs, but that's fine.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D133349

_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to