Skip to content
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

[llvm-objcopy][docs] Use "Mark" rather than "Make" in the objcopy docs for consistency #90080

Merged

Conversation

bd1976bris
Copy link
Collaborator

@bd1976bris bd1976bris commented Apr 25, 2024

Docs were recently improved in #82830 - great! Whilst
reviewing those changes I noticed that we are inconsistent
sometimes using "Make" and in other places "Mark".

This PR removes the use of the word "Make" in favor of
"Mark". The --help text already used "Mark" everywhere
so no updates to it were required.

@llvmbot
Copy link
Collaborator

llvmbot commented Apr 25, 2024

@llvm/pr-subscribers-llvm-binary-utilities

Author: bd1976bris (bd1976bris)

Changes

Docs were recently improved in #82830 - great! Whilst
reviewing those changes I noticed that we are incosistent
sometimes using "Make" and in other places "Mark".

This PR removes the use of the word "Make" in favour of
"Mark". The --help text already used "Mark" everywhere
so no updates to it were requried.


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

1 Files Affected:

  • (modified) llvm/docs/CommandGuide/llvm-objcopy.rst (+3-3)
diff --git a/llvm/docs/CommandGuide/llvm-objcopy.rst b/llvm/docs/CommandGuide/llvm-objcopy.rst
index 57d6280d57c8bd..a62acfc8fdcd80 100644
--- a/llvm/docs/CommandGuide/llvm-objcopy.rst
+++ b/llvm/docs/CommandGuide/llvm-objcopy.rst
@@ -366,12 +366,12 @@ them.
 
 .. option:: --keep-global-symbol <symbol>, -G
 
- Make all symbols local in the output, except for symbols with the name
+ Mark all symbols local in the output, except for symbols with the name
  ``<symbol>``. Can be specified multiple times to ignore multiple symbols.
 
 .. option:: --keep-global-symbols <filename>
 
- Make all symbols local in the output, except for symbols named in the file
+ Mark all symbols local in the output, except for symbols named in the file
  ``<filename>``. In the file, each line represents a single symbol, with leading
  and trailing whitespace ignored, as is anything following a '#'. Can be
  specified multiple times to read names from multiple files.
@@ -395,7 +395,7 @@ them.
 
 .. option:: --localize-hidden
 
- Make all symbols with hidden or internal visibility local in the output.
+ Mark all symbols with hidden or internal visibility local in the output.
 
 .. option:: --localize-symbol <symbol>, -L
 

@MaskRay
Copy link
Member

MaskRay commented Apr 25, 2024

Thanks! llvm-objcopy --help uses Mark. This PR changes llvm/docs to align.

Copy link
Member

@MaskRay MaskRay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider [docs] tag

Copy link
Collaborator

@jh7370 jh7370 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

For some reason the pre-merge checks list as having 1 failing, yet there is no such check in the expanded checks listed :/

@bd1976bris bd1976bris changed the title Use "Mark" rather than "Make" in the objcopy docs for consistency [docs] Use "Mark" rather than "Make" in the objcopy docs for consistency Apr 26, 2024
@bd1976bris bd1976bris changed the title [docs] Use "Mark" rather than "Make" in the objcopy docs for consistency [llvm-objcopy][docs] Use "Mark" rather than "Make" in the objcopy docs for consistency Apr 26, 2024
@bd1976bris bd1976bris merged commit 88a733f into llvm:main Apr 26, 2024
7 of 8 checks passed
@bd1976bris bd1976bris deleted the use_mark_consistently_in_objcopy_docs branch April 26, 2024 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants