This is an archive of the discontinued LLVM Phabricator instance.

Explain --reproduce option.
ClosedPublic

Authored by ruiu on Apr 11 2019, 2:26 AM.

Download Raw Diff

Details

Reviewers

emaste
MaskRay

Commits

rG72d1089a3a69: Explain --reproduce option
rLLD369740: Explain --reproduce option
rL369740: Explain --reproduce option

Summary

I think --reproduce is no longer a debug-only option but a useful
option that a common user may want to use. So, this patch updates
the description of the option in the manual page.

Diff Detail

Repository: rL LLVM

Event Timeline

ruiu created this revision.Apr 11 2019, 2:26 AM

Herald added a project: Restricted Project. · View Herald TranscriptApr 11 2019, 2:26 AM

Harbormaster completed remote builds in B30361: Diff 194651.Apr 11 2019, 2:27 AM

ruiu added a reviewer: MaskRay.Aug 23 2019, 12:51 AM

The updated description looks good to me. I even use this option to debug GNU linkers a lot (usually to check why/how they do ABC) because they don't provide this nice feature...

+@grimar @peter.smith in case they have wording suggestions.

This revision is now accepted and ready to land.Aug 23 2019, 1:33 AM

Yeah, I actually like this option *a lot*. This is one of the best features we've added to lld.

Closed by commit rL369740: Explain --reproduce option (authored by ruiu). · Explain WhyAug 23 2019, 1:52 AM

This revision was automatically updated to reflect the committed changes.

It would be good to get at least the tar file part added to the ld.lld --help option, I remember having to use the file command the first time I used --reproduce and I think more people will use --help than look in the man page.

lld/trunk/docs/ld.lld.1
411	I think this will work fine. A suggestion that gives a bit more detail on the contents, not got a strong opinion so by all means keep the original. Write a tar file containing all the input files needed to reproduce the link, a text file called response.txt containing the command line options and a text file called version.txt containing the output of ld.lld --version. The archive when unpacked can be used to re-run the linker with the same options and input files.

In D60557#1642458, @peter.smith wrote:

It would be good to get at least the tar file part added to the ld.lld --help option, I remember having to use the file command the first time I used --reproduce and I think more people will use --help than look in the man page.

I like that detailed explanation. I've already submitted this change, but can you submit yours to update it?

In D60557#1642466, @ruiu wrote:

In D60557#1642458, @peter.smith wrote:

It would be good to get at least the tar file part added to the ld.lld --help option, I remember having to use the file command the first time I used --reproduce and I think more people will use --help than look in the man page.

I like that detailed explanation. I've already submitted this change, but can you submit yours to update it?

Sure I'll send out a review in a few moments.

peter.smith mentioned this in D66641: [LLD][ELF] Mention contents of reproduce archive and add help description..Aug 23 2019, 4:19 AM

psmith mentioned this in rL369762: [ELF] Mention contents of reproduce archive and add help description..Aug 23 2019, 7:43 AM

peter.smith mentioned this in rG7d6aa7eb7f58: [ELF] Mention contents of reproduce archive and add help description..Aug 23 2019, 7:43 AM

Revision Contents

Path

Size

lld/

trunk/

docs/

ld.lld.1

6 lines

Diff 216781

lld/trunk/docs/ld.lld.1

	Show First 20 Lines • Show All 401 Lines • ▼ Show 20 Lines
	.Fl -static ,			.Fl -static ,
	and			and
	.Fl -whole-archive.			.Fl -whole-archive.
	.It Fl -pop-state			.It Fl -pop-state
	Undo the effect of			Undo the effect of
	.Fl -push-state.			.Fl -push-state.
	.It Fl -relocatable , Fl r			.It Fl -relocatable , Fl r
	Create relocatable object file.			Create relocatable object file.
	.It Fl -reproduce Ns = Ns Ar value			.It Fl -reproduce Ns = Ns Ar path
	Dump linker invocation and input files for debugging.			Write a tar file containing all input files and a text file describing the link invocation to
				peter.smithUnsubmitted Not Done Reply Inline Actions I think this will work fine. A suggestion that gives a bit more detail on the contents, not got a strong opinion so by all means keep the original. Write a tar file containing all the input files needed to reproduce the link, a text file called response.txt containing the command line options and a text file called version.txt containing the output of ld.lld --version. The archive when unpacked can be used to re-run the linker with the same options and input files. peter.smith: I think this will work fine. A suggestion that gives a bit more detail on the contents, not got…
				.Ar path,
				so that you can easily re-run the linker with the same options and input files.
	.It Fl -retain-symbols-file Ns = Ns Ar file			.It Fl -retain-symbols-file Ns = Ns Ar file
	Retain only the symbols listed in the file.			Retain only the symbols listed in the file.
	.It Fl -rpath Ns = Ns Ar value , Fl R Ar value			.It Fl -rpath Ns = Ns Ar value , Fl R Ar value
	Add a			Add a
	.Dv DT_RUNPATH			.Dv DT_RUNPATH
	to the output.			to the output.
	.It Fl -rsp-quoting Ns = Ns Ar value			.It Fl -rsp-quoting Ns = Ns Ar value
	Quoting style for response files.			Quoting style for response files.
	▲ Show 20 Lines • Show All 292 Lines • Show Last 20 Lines