Skip to content

[clang][docs] Fix docs-clang-html. #142387

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[clang][docs] Fix docs-clang-html. #142387

wants to merge 1 commit into from

Conversation

abidh
Copy link
Contributor

@abidh abidh commented Jun 2, 2025

I observed that docs-clang-html is failing since #142158 with the following:

Warning, treated as error:
tools/clang/docs/DiagnosticsReference.rst:18000:Unexpected indentation. ninja: build stopped: subcommand failed.

Adding an extra empty line here fixes the build.

I observed that docs-clang-html is failing since llvm#142158,

Warning, treated as error:
tools/clang/docs/DiagnosticsReference.rst:18000:Unexpected indentation.
ninja: build stopped: subcommand failed.

Adding an extra empty line here fixes the build.
@abidh abidh requested a review from nico June 2, 2025 13:12
@llvmbot llvmbot added clang Clang issues not falling into any other category clang:frontend Language frontend issues, e.g. anything involving "Sema" labels Jun 2, 2025
@llvmbot
Copy link
Member

llvmbot commented Jun 2, 2025

@llvm/pr-subscribers-clang

Author: Abid Qadeer (abidh)

Changes

I observed that docs-clang-html is failing since #142158 with the following:

Warning, treated as error:
tools/clang/docs/DiagnosticsReference.rst:18000:Unexpected indentation. ninja: build stopped: subcommand failed.

Adding an extra empty line here fixes the build.


Full diff: https://github.com/llvm/llvm-project/pull/142387.diff

1 Files Affected:

  • (modified) clang/include/clang/Basic/DiagnosticGroups.td (+1)
diff --git a/clang/include/clang/Basic/DiagnosticGroups.td b/clang/include/clang/Basic/DiagnosticGroups.td
index 60c650583801a..0161b3953f282 100644
--- a/clang/include/clang/Basic/DiagnosticGroups.td
+++ b/clang/include/clang/Basic/DiagnosticGroups.td
@@ -821,6 +821,7 @@ As well as one of the following:
 
 The warning can be resolved by removing one of the conditions above. In rough
 order of preference, this may be done by:
+
   1. Marking the object ``const`` (if possible)
   2. Moving the object's definition to a source file
   3. Giving the object non-hidden visibility, e.g. using ``__attribute((visibility("default")))``.

@abidh
Copy link
Contributor Author

abidh commented Jun 2, 2025

I see that https://clang.llvm.org/docs/DiagnosticsReference.html#wunique-object-duplication is showing this correctly without this PR so problem may be something local to my machine. Closing it for now.

@abidh abidh closed this Jun 2, 2025
@Mr-Anyone
Copy link
Contributor

I think I am seeing something similar on CI:

https://github.com/llvm/llvm-project/actions/runs/15387162550/job/43288136977?pr=140278

@abidh
Copy link
Contributor Author

abidh commented Jun 2, 2025

I think I am seeing something similar on CI:

https://github.com/llvm/llvm-project/actions/runs/15387162550/job/43288136977?pr=140278

Thanks for reporting this. I think I will reopen it.

@frederick-vs-ja
Copy link
Contributor

I wonder whether it would be better to modify .github/workflows/docs.yml together. It seems that modification of some transitively included td files doesn't trigger CI for documentation.

@ojhunt
Copy link
Contributor

ojhunt commented Jun 4, 2025

this is tripping on CI and my machine.

To repro I need to delete $BUILD_DIR/tools/clang/docs and build with TZ=UTC ninja docs-clang-man

I find it necessary to delete the doc directory to trigger this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang:frontend Language frontend issues, e.g. anything involving "Sema" clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants