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

proposal: add $GOROOT/HACKING.md #29028

Closed
forskning opened this issue Nov 30, 2018 · 6 comments

Comments

Projects
None yet
5 participants
@forskning
Copy link

commented Nov 30, 2018

Such a file could contain sections on using different shells, multiplexers, and address the deficiency alleged in the existing documentation in #28905, as the use of $GOPATH as a delimited list; furthermore the following which was established as the outcome of an earlier issue suggesting to document what's in $GOROOT, didn't come out very well.

https://github.com/golang/go/wiki/FileTreeDocumentation

@gopherbot gopherbot added this to the Proposal milestone Nov 30, 2018

@gopherbot gopherbot added the Proposal label Nov 30, 2018

@ianlancetaylor

This comment has been minimized.

Copy link
Contributor

commented Nov 30, 2018

I believe this kind of information is better placed on the wiki than in a file in the repo.

@mvdan mvdan added the Documentation label Nov 30, 2018

@forskning

This comment has been minimized.

Copy link
Author

commented Nov 30, 2018

I'm not sure the coders' 'moment' should be the sole determining factor in a debate on where to locate within the file tree information, e.g., currently deferring to HTML and/or Wiki pages, and, on behalf of pædagogy would prefer explanations of the PATH variable modification using different shells, Acme, Emacs and vi(m) usage, ubiquitous across OSes, and more advanced shell use with multiplexers, also hubfs, in such a proposed flat file.

Daniel Mornet, Précis de Littérature Française, Larousse, Paris, 1925, on the positivist Hippolyte Taine:

« Ce déterminisme d’était pas nouveau : la race, le milieu (se qu’on appelait les climats), le moment même avaient été allégués avant Taine, par Montesquieu et d’autres, dès le XVIIIe siècle. L’originalité de Taine est de les avoir ordonnés dans un système rigoureux et puissamment illustré d’exemples. Elle est surtout d’y avoir ajouté autre chose qui les anime et qui les transpose. »

...« L’art de Taine pourrait se définir : positivisme et passion. »

@ianlancetaylor

This comment has been minimized.

Copy link
Contributor

commented Nov 30, 2018

The Go tree is definitely not the correct place to document how to set the PATH variable in different environments.

@forskning

This comment has been minimized.

Copy link
Author

commented Nov 30, 2018

set the PATH variable in different environments

I wasn't inferring this be a sole location for such information, rather that such a flat file contain rudimentary material, summarising some of the content currently on the Wiki, and, from other contributed sources, contain more advanced subject material; but you, or other contributors/members, are welcome to close this issue.

@forskning

This comment has been minimized.

Copy link
Author

commented Nov 30, 2018

Perhaps rather than one top level HACKING.md file, something akin, absent installation instructions, to Perl's platform specific files, i.e., README.linux, README.plan9, README.win32.

perl5 (mirror)

@andybons

This comment has been minimized.

Copy link
Member

commented Dec 5, 2018

Thanks. Per discussion with @golang/proposal-review, we’ve decided that this information is better suited for the wiki or other location outside of the source tree.

@andybons andybons closed this Dec 5, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.