Issue 54760044: code review 54760044: cmd/gc: add the word 'archive' to the documentation for... (Closed)
Descriptioncmd/gc: add the word 'archive' to the documentation for -pack
The term "package file" is unclear.
Patch Set 1 #Patch Set 2 : diff -r c057b92310eb https://code.google.com/p/go #
Total comments: 1
Patch Set 3 : diff -r c057b92310eb https://code.google.com/p/go #
Total comments: 1
Patch Set 4 : diff -r 654b2703fcc4 https://code.google.com/p/go #Patch Set 5 : diff -r 654b2703fcc4 https://code.google.com/p/go #MessagesTotal messages: 12
Hello iant (cc: golang-codereviews@googlegroups.com), I'd like you to review this change to https://code.google.com/p/go
Sign in to reply to this message.
why not drop package altogether and say 'write an archive file rather than an object file', that is what it does after all. On Wed, Jan 22, 2014 at 7:41 AM, <r@golang.org> wrote: > Reviewers: iant, > > Message: > Hello iant (cc: golang-codereviews@googlegroups.com), > > I'd like you to review this change to > https://code.google.com/p/go > > > Description: > cmd/gc: add the word 'archive' to the documentation for -pack > The term "package file" is unclear. > > Please review this at https://codereview.appspot.com/54760044/ > > Affected files (+1, -1 lines): > M src/cmd/gc/doc.go > > > Index: src/cmd/gc/doc.go > =================================================================== > --- a/src/cmd/gc/doc.go > +++ b/src/cmd/gc/doc.go > @@ -38,7 +38,7 @@ > -o file > output file, default file.6 for 6g, etc. > -pack > - write a package file rather than an object file > + write a package file (archive) rather than an object file > -e > normally the compiler quits after 10 errors; -e prints all > errors > -p path > > > -- > You received this message because you are subscribed to the Google Groups > "golang-codereviews" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to golang-codereviews+unsubscribe@googlegroups.com. > For more options, visit https://groups.google.com/groups/opt_out. >
Sign in to reply to this message.
Hello iant@golang.org, dave@cheney.net (cc: golang-codereviews@googlegroups.com), Please take another look.
Sign in to reply to this message.
LGTM. > On 22 Jan 2014, at 9:05, r@golang.org wrote: > > Hello iant@golang.org, dave@cheney.net (cc: > golang-codereviews@googlegroups.com), > > Please take another look. > > > https://codereview.appspot.com/54760044/
Sign in to reply to this message.
https://codereview.appspot.com/54760044/diff/20001/src/cmd/gc/doc.go File src/cmd/gc/doc.go (right): https://codereview.appspot.com/54760044/diff/20001/src/cmd/gc/doc.go#newcode41 src/cmd/gc/doc.go:41: write an archive file (see go tool pack) rather than an object file Perhaps s/see/like/ ? Telling people to "see go tool pack" seems odd since there is nothing to see.
Sign in to reply to this message.
Hello iant@golang.org, dave@cheney.net (cc: golang-codereviews@googlegroups.com), Please take another look.
Sign in to reply to this message.
https://codereview.appspot.com/54760044/diff/30001/src/cmd/gc/doc.go File src/cmd/gc/doc.go (right): https://codereview.appspot.com/54760044/diff/30001/src/cmd/gc/doc.go#newcode41 src/cmd/gc/doc.go:41: write an archive file (for go tool pack) rather than an object file Sorry, this still doesn't seem quite right to me. The archive file is not for go tool pack. In many cases go tool pack will never be run. The archive file is for the linker. go tool pack is a tool that is used to create and modify archive files in cases where -pack is unable to do the whole job.
Sign in to reply to this message.
Please suggest the wording you want then. There is no such thing as a "package file" as far as I know. So: what is it? On Tue, Jan 21, 2014 at 4:28 PM, <iant@golang.org> wrote: > > https://codereview.appspot.com/54760044/diff/30001/src/cmd/gc/doc.go > File src/cmd/gc/doc.go (right): > > https://codereview.appspot.com/54760044/diff/30001/src/cmd/gc/doc.go#newcode41 > src/cmd/gc/doc.go:41: write an archive file (for go tool pack) rather > than an object file > Sorry, this still doesn't seem quite right to me. The archive file is > not for go tool pack. In many cases go tool pack will never be run. > The archive file is for the linker. go tool pack is a tool that is used > to create and modify archive files in cases where -pack is unable to do > the whole job. > > https://codereview.appspot.com/54760044/
Sign in to reply to this message.
On Tue, Jan 21, 2014 at 4:32 PM, Rob Pike <r@golang.org> wrote: > Please suggest the wording you want then. There is no such thing as a > "package file" as far as I know. So: what is it? Fair point (I would say a package file is an archive with a PKGDEF entry, but that is obscure). How about simply "write an archive rather than an object file"? Or: "write an archive with a package definition section rather than an object file". I think that talking about go tool pack here is a red herring because after your recent change go tool pack no longer creates the package definition section that is a key component of the archive file. So in practice the -pack option is now mandatory as there is no other way to get a package definition section. Ian > > > On Tue, Jan 21, 2014 at 4:28 PM, <iant@golang.org> wrote: >> >> https://codereview.appspot.com/54760044/diff/30001/src/cmd/gc/doc.go >> File src/cmd/gc/doc.go (right): >> >> https://codereview.appspot.com/54760044/diff/30001/src/cmd/gc/doc.go#newcode41 >> src/cmd/gc/doc.go:41: write an archive file (for go tool pack) rather >> than an object file >> Sorry, this still doesn't seem quite right to me. The archive file is >> not for go tool pack. In many cases go tool pack will never be run. >> The archive file is for the linker. go tool pack is a tool that is used >> to create and modify archive files in cases where -pack is unable to do >> the whole job. >> >> https://codereview.appspot.com/54760044/
Sign in to reply to this message.
Hello iant@golang.org, dave@cheney.net (cc: golang-codereviews@googlegroups.com), Please take another look.
Sign in to reply to this message.
LGTM Sorry for all the trouble.
Sign in to reply to this message.
*** Submitted as https://code.google.com/p/go/source/detail?r=7abe32ccffb1 *** cmd/gc: add the word 'archive' to the documentation for -pack The term "package file" is unclear. R=iant, dave CC=golang-codereviews https://codereview.appspot.com/54760044
Sign in to reply to this message.
|
