Clarify documentation for -funique-source-file-names. #135832
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Created using spr 1.3.6-beta.1
|
@llvm/pr-subscribers-clang Author: Peter Collingbourne (pcc) ChangesFull diff: https://github.com/llvm/llvm-project/pull/135832.diff 1 Files Affected:
diff --git a/clang/docs/UsersManual.rst b/clang/docs/UsersManual.rst
index d4656a7e63c99..c75e409dde55e 100644
--- a/clang/docs/UsersManual.rst
+++ b/clang/docs/UsersManual.rst
@@ -2301,11 +2301,31 @@ are listed below.
When enabled, allows the compiler to assume that each object file
passed to the linker has been compiled using a unique source file
- name. This is useful for reducing link times when doing ThinLTO
+ path. This is useful for reducing link times when doing ThinLTO
in combination with whole-program devirtualization or CFI.
- A misuse of this flag will generally result in a duplicate symbol
- error at link time.
+ The full source path passed to the compiler must be unique. This
+ means that, for example, the following is a usage error:
+
+ .. code-block:: console
+
+ $ cd foo
+ $ clang -funique-source-file-names -c foo.c
+ $ cd ../bar
+ $ clang -funique-source-file-names -c foo.c
+ $ cd ..
+ $ clang foo/foo.o bar/foo.o
+
+ but this is not:
+
+ .. code-block:: console
+
+ $ clang -funique-source-file-names -c foo/foo.c
+ $ clang -funique-source-file-names -c bar/foo.c
+ $ clang foo/foo.o bar/foo.o
+
+ A misuse of this flag will generally either be harmless or result
+ in a duplicate symbol error at link time.
.. option:: -fforce-emit-vtables
|
teresajohnson
approved these changes
Apr 15, 2025
clang/docs/UsersManual.rst
Outdated
| $ clang -funique-source-file-names -c bar/foo.c | ||
| $ clang foo/foo.o bar/foo.o | ||
|
|
||
| A misuse of this flag will generally either be harmless or result |
There was a problem hiding this comment.
I'd prefer to remove the harmless comment as it would be good to discourage uses that violate the intent. So maybe just "may result in a duplicate ..." ?
Created using spr 1.3.6-beta.1
pcc
commented
Apr 15, 2025
There was a problem hiding this comment.
Will leave this for a bit in case @efriedma-quic has any comments
clang/docs/UsersManual.rst
Outdated
| $ clang -funique-source-file-names -c bar/foo.c | ||
| $ clang foo/foo.o bar/foo.o | ||
|
|
||
| A misuse of this flag will generally either be harmless or result |
efriedma-quic
approved these changes
Apr 15, 2025
pcc
deleted the
users/pcc/spr/clarify-documentation-for-funique-source-file-names
branch
llvm-sync bot
pushed a commit
to arm/arm-toolchain
that referenced
this pull request
Apr 15, 2025
Reviewers: efriedma-quic, teresajohnson Reviewed By: teresajohnson, efriedma-quic Pull Request: llvm/llvm-project#135832
var-const
pushed a commit
to ldionne/llvm-project
that referenced
this pull request
Apr 17, 2025
Reviewers: efriedma-quic, teresajohnson Reviewed By: teresajohnson, efriedma-quic Pull Request: llvm#135832
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.