code review 12316043: misc/dist: don't ship cmd/api

misc/dist: don't ship cmd/api

cmd/api is a tool to prevent the Go developers from breaking
the Go 1 API promise. It has no utility to end users and
doesn't run on arbitrary packages (it's always been full of
hacks for its bespoke type checker to work on the standard
library)

Robert's in-progress rewrite depends on the go.tools repo for
go/types, so we won't be able to ship this tool later
anyway. Just remove it from binary distributions.

A future change to run.bash can conditionally build & run
cmd/api, perhaps automatically fetching go/types if
necessary. I assume people don't want to vendor go/types into
a private gopath just for cmd/api.

I will need help with run.bat.

[bradfitz, 2013-08-02 03:34:32]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://go.googlecode.com/hg/

[adg1, 2013-08-02 03:49:58]

Maybe we should strip out all.bash, make.bash, the dist tool, etc from the
binary distros too?
On 2 Aug 2013 13:34, <bradfitz@golang.org> wrote:

> Reviewers: golang-dev1,
>
> Message:
> Hello golang-dev@googlegroups.com,
>
> I'd like you to review this change to
> https://go.googlecode.com/hg/
>
>
> Description:
> misc/dist: don't ship cmd/api
>
> cmd/api is a tool to prevent the Go developer from breaking
> the Go 1 API promise. It has no utility to end users and
> doesn't run on arbitrary packages (it's always been full of
> hacks for its bespoke type checker to work on the standard
> library)
>
> Robert's in-progress rewrite depends on the go.tools repo for
> go/types, so we won't be able to ship this tool later
> anyway. Just remove it from binary distributions.
>
> A future change to run.bash can conditionally build & run
> cmd/api, perhaps automatically fetching go/types if
> necessary. I assume people don't want to vendor go/types into
> a private gopath just for cmd/api.
>
> I will need help with run.bat.
>
> Please review this at
https://codereview.appspot.**com/12316043/<https://codereview.appspot.com/123...
>
> Affected files:
>   M misc/dist/bindist.go
>   M src/run.bash
>
>
> Index: misc/dist/bindist.go
> ==============================**==============================**=======
> --- a/misc/dist/bindist.go
> +++ b/misc/dist/bindist.go
> @@ -50,6 +50,7 @@
>  var preBuildCleanFiles = []string{
>         "lib/codereview",
>         "misc/dashboard/godashboard",
> +       "src/cmd/api",
>         "src/cmd/cov",
>         "src/cmd/prof",
>         "src/pkg/exp",
> Index: src/run.bash
> ==============================**==============================**=======
> --- a/src/run.bash
> +++ b/src/run.bash
> @@ -176,9 +176,12 @@
>  time go run run.go || exit 1
>  ) || exit $?
>
> -echo
> -echo '# Checking API compatibility.'
> -go tool api -c $GOROOT/api/go1.txt,$GOROOT/**api/go1.1.txt -next
> $GOROOT/api/next.txt -except $GOROOT/api/except.txt
> +if [ -d "$GOROOT/src/cmd/api" ]
> +then
> +  echo
> +  echo '# Checking API compatibility.'
> +  go tool api -c $GOROOT/api/go1.txt,$GOROOT/**api/go1.1.txt -next
> $GOROOT/api/next.txt -except $GOROOT/api/except.txt
> +fi
>
>  echo
>  echo ALL TESTS PASSED
>
>
> --
>
> ---You received this message because you are subscribed to the Google
> Groups "golang-dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to
golang-dev+unsubscribe@**googlegroups.com<golang-dev%2Bunsubscribe@googlegrou...
> .
> For more options, visit
https://groups.google.com/**groups/opt_out<https://groups.google.com/groups/o...
> .
>
>
>

[dsymonds, 2013-08-02 03:50:50]

The misc/dist/bindist.go change looks fine, but it'd be nice to leave
the execution of the api tool at the bottom of run.bash as long as
possible.

[bradfitz, 2013-08-02 03:56:07]

On Thu, Aug 1, 2013 at 8:50 PM, David Symonds <dsymonds@golang.org> wrote:

> The misc/dist/bindist.go change looks fine, but it'd be nice to leave
> the execution of the api tool at the bottom of run.bash as long as
> possible.


I'm confused.

It's still there for us and will continue to work after this change.  I
tried it.

The change in run.bash is there for people who try to run {run,all}.bash
from the *.tar.gz download.

When Robert's CL goes in, then we can discuss more extensive run.bash
changes down there.

But regardless of what we do to run.bash then, I don't think we should ever
ship any version of cmd/api.  That's what this CL is about.

[bradfitz, 2013-08-02 03:56:34]

On Thu, Aug 1, 2013 at 8:49 PM, Andrew Gerrand <adg@google.com> wrote:

> Maybe we should strip out all.bash, make.bash, the dist tool, etc from the
> binary distros too?
>

Sure.  That's up to you.  But don't break the *.tar.gz release.
 "bin"dist.go does that too.

[dsymonds, 2013-08-02 04:01:47]

Hmm. The source downloads were always a bit odd in my mind. I would
have thought that people grabbing them would be just as interested in
the cmd/api output as we who have hg checkouts.

[bradfitz, 2013-08-02 04:06:09]

No, they're not hacking on the standard library and sending patches.
They're just compiling.

Tough for them if otherwise: cmd/api is either growing an out-of-tree dep
or it's moving itself. Either way, they don't get it anymore. It was never
promised.
 On Aug 1, 2013 9:01 PM, "David Symonds" <dsymonds@golang.org> wrote:

> Hmm. The source downloads were always a bit odd in my mind. I would
> have thought that people grabbing them would be just as interested in
> the cmd/api output as we who have hg checkouts.
>

[dsymonds, 2013-08-02 04:08:29]

How do they get godoc? Isn't that in the same situation?

[dsymonds, 2013-08-02 04:10:42]

anyway, LGTM

[adg1, 2013-08-02 05:21:08]

Ah, I forgot about the source tarballs.

LGTM
On 2 Aug 2013 13:56, "Brad Fitzpatrick" <bradfitz@golang.org> wrote:

>
>
>
> On Thu, Aug 1, 2013 at 8:49 PM, Andrew Gerrand <adg@google.com> wrote:
>
>> Maybe we should strip out all.bash, make.bash, the dist tool, etc from
>> the binary distros too?
>>
>
> Sure.  That's up to you.  But don't break the *.tar.gz release.
>  "bin"dist.go does that too.
>
>

[rsc, 2013-08-02 17:01:49]

LGTM

https://codereview.appspot.com/12316043/diff/6001/src/run.bash
File src/run.bash (right):

https://codereview.appspot.com/12316043/diff/6001/src/run.bash#newcode181
src/run.bash:181: echo
tabs please

[bradfitz, 2013-08-02 17:15:59]

https://codereview.appspot.com/12316043/diff/6001/src/run.bash
File src/run.bash (right):

https://codereview.appspot.com/12316043/diff/6001/src/run.bash#newcode181
src/run.bash:181: echo
On 2013/08/02 17:01:49, rsc wrote:
> tabs please

Done.

[bradfitz, 2013-08-02 17:19:56]

*** Submitted as https://code.google.com/p/go/source/detail?r=564e8c77a065 ***

misc/dist: don't ship cmd/api

cmd/api is a tool to prevent the Go developers from breaking
the Go 1 API promise. It has no utility to end users and
doesn't run on arbitrary packages (it's always been full of
hacks for its bespoke type checker to work on the standard
library)

Robert's in-progress rewrite depends on the go.tools repo for
go/types, so we won't be able to ship this tool later
anyway. Just remove it from binary distributions.

A future change to run.bash can conditionally build & run
cmd/api, perhaps automatically fetching go/types if
necessary. I assume people don't want to vendor go/types into
a private gopath just for cmd/api.

I will need help with run.bat.

R=golang-dev, adg, dsymonds, rsc
CC=golang-dev
https://codereview.appspot.com/12316043