This is an archive of the discontinued LLVM Phabricator instance.

Differential D143600

[ELF][docs] Mention LLD_REPRODUCE and LLD_VERSION
ClosedPublic

Authored by MaskRay on Feb 8 2023, 12:02 PM.

Details

Reviewers
peter.smith
Commits
rG3d570a5c5f66: [ELF][docs] Mention LLD_REPRODUCE and LLD_VERSION

Diff Detail

Event Timeline

MaskRay created this revision.Feb 8 2023, 12:02 PM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 8 2023, 12:02 PM
MaskRay requested review of this revision.Feb 8 2023, 12:02 PM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 8 2023, 12:02 PM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Harbormaster completed remote builds in B212660: Diff 495909.Feb 8 2023, 12:16 PM
MaskRay updated this revision to Diff 495916.Feb 8 2023, 12:22 PM

update date

Harbormaster completed remote builds in B212667: Diff 495916.Feb 8 2023, 12:48 PM
peter.smith accepted this revision.Feb 9 2023, 2:00 AM

LGTM, a couple of small suggestions.

lld/docs/ld.lld.1
7

Did you mean Feb 9, 2023?

892

I recommend changing "indicating its version" to "containing the LLD version string."

The comment for getVersion() says:

// Check LLD_VERSION first for ease of testing.                                                                                                                   // You can get consistent output by using the environment variable.                                                                                               // This is only for testing.

perhaps worth adding. "This option is useful to eliminate differences in the binary caused by LLD version number differences."

This revision is now accepted and ready to land.Feb 9 2023, 2:00 AM
MaskRay updated this revision to Diff 496240.Feb 9 2023, 2:35 PM
MaskRay marked an inline comment as done.

comments

MaskRay updated this revision to Diff 496241.Feb 9 2023, 2:36 PM

fix date

MaskRay added inline comments.Feb 9 2023, 2:38 PM
lld/docs/ld.lld.1
892

Thanks for the suggestion!

This revision was landed with ongoing or failed builds.Feb 9 2023, 2:38 PM
Closed by commit rG3d570a5c5f66: [ELF][docs] Mention LLD_REPRODUCE and LLD_VERSION (authored by MaskRay). · Explain Why
This revision was automatically updated to reflect the committed changes.
MaskRay added a commit: rG3d570a5c5f66: [ELF][docs] Mention LLD_REPRODUCE and LLD_VERSION.
Harbormaster completed remote builds in B212896: Diff 496241.Feb 9 2023, 3:06 PM

Revision Contents

PathSize
lld/
docs/
18 lines

Diff 496242

lld/docs/ld.lld.1

.\" Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. .\" Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
.\" See https://llvm.org/LICENSE.txt for license information. .\" See https://llvm.org/LICENSE.txt for license information.
.\" SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception .\" SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
.\" .\"
.\" This man page documents only lld's ELF linking support, obtained originally .\" This man page documents only lld's ELF linking support, obtained originally
.\" from FreeBSD. .\" from FreeBSD.
.Dd May 12, 2019 .Dd Feb 9, 2023
peter.smithUnsubmitted
Not Done
ReplyInline Actions

Did you mean Feb 9, 2023?

peter.smith: Did you mean Feb 9, 2023?
.Dt LD.LLD 1 .Dt LD.LLD 1
.Os .Os
.Sh NAME .Sh NAME
.Nm ld.lld .Nm ld.lld
.Nd ELF linker from the LLVM project .Nd ELF linker from the LLVM project
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm ld.lld .Nm ld.lld
.Op Ar options .Op Ar options
▲ Show 20 Lines • Show All 856 Lines • ▼ Show 20 Lines
This is the default. This is the default.
.Pp .Pp
.It Cm wxneeded .It Cm wxneeded
Create a Create a
.Dv PT_OPENBSD_WXNEEDED .Dv PT_OPENBSD_WXNEEDED
segment. segment.
.El .El
.El .El
.Sh ENVIRONMENT VARIABLES
.Bl -tag -width LC_CTYPE
.It Ev LLD_REPRODUCE
Create a reproduce tarball with the specified filename. If
.Fl -reproduce
is specified,
.Fl -reproduce
takes precedence.
.It Ev LLD_VERSION
ld.lld creates a section named
.Cm .comment
containing the LLD version string. The version string can be overridden by this environment variable,
peter.smithUnsubmitted
Done
ReplyInline Actions

I recommend changing "indicating its version" to "containing the LLD version string."

The comment for getVersion() says:

// Check LLD_VERSION first for ease of testing.                                                                                                                   // You can get consistent output by using the environment variable.                                                                                               // This is only for testing.

perhaps worth adding. "This option is useful to eliminate differences in the binary caused by LLD version number differences."

peter.smith: I recommend changing "indicating its version" to "containing the LLD version string." The…
MaskRayAuthorUnsubmitted
Done
ReplyInline Actions

Thanks for the suggestion!

MaskRay: Thanks for the suggestion!
which is useful to eliminate differences in the binary caused by LLD version number differences.
.El
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
.Nm Ap s .Nm Ap s
handing of archive files (those with a handing of archive files (those with a
.Pa .a .Pa .a
file extension) is different from traditional linkers used on Unix-like file extension) is different from traditional linkers used on Unix-like
systems. systems.
.Pp .Pp
Traditional linkers maintain a set of undefined symbols during linking. Traditional linkers maintain a set of undefined symbols during linking.
Show All 38 Lines