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

Create page for environment variables the interpreter uses #949

Closed
coke opened this issue Oct 10, 2016 · 23 comments
Closed

Create page for environment variables the interpreter uses #949

coke opened this issue Oct 10, 2016 · 23 comments
Labels
good first issue If you want to dive in, this would be a good place to start

Comments

@coke
Copy link
Collaborator

coke commented Oct 10, 2016

e.g. search for RAKUDO_NO_DEPRECATIONS

@coke
Copy link
Collaborator Author

coke commented Dec 2, 2016

FYI, bad example if we're removing RAKUDO specific env vars.

@coke coke added the search label Dec 2, 2016
@AlexDaniel
Copy link
Member

AlexDaniel commented Sep 3, 2017

Errr… pretty sure that this page has to be deleted. All useful info from it should be moved to https://github.com/rakudo/rakudo/wiki/dev-env-vars (and other rakudo wiki pages)

@AlexDaniel AlexDaniel added the LHF label Sep 3, 2017
@AlexDaniel AlexDaniel changed the title env vars described on https://docs.perl6.org/programs/00-running#ENVIRONMENT_VARIABLES not in search Move programs/00-running to rakudo wiki Sep 3, 2017
@JJ
Copy link
Contributor

JJ commented Feb 9, 2018

That's two different things, removing the page and moving it to rakudo wiki or doc page. The second part will depend on what the devs there will want to do with them, right?

@coke
Copy link
Collaborator Author

coke commented Feb 9, 2018

One big happy family, we shouldn't remove it from here until it's listed there.

@JJ
Copy link
Contributor

JJ commented Feb 9, 2018

Big happy family with 2-year old issues that are already teething... I get your point, but still...

@coke
Copy link
Collaborator Author

coke commented Feb 9, 2018

Yes, I'm well aware of how old some of theses issues are, especially the ones I've opened. Patches and updates most welcome, thank you.

@AlexDaniel
Copy link
Member

@JJ fwiw you should have access to edit rakudo wiki, and wikis are editable by all by definition. Devs are irrelevant in this case.

@JJ
Copy link
Contributor

JJ commented Feb 9, 2018 via email

@JJ
Copy link
Contributor

JJ commented Feb 9, 2018 via email

@AlexDaniel
Copy link
Member

@JJ wiki pages on github support different markup languages. POD5 is supported. Converting POD6 to POD5 shouldn't take enormous amounts of effort I assume (I'm speaking of doing it manually).

@JJ
Copy link
Contributor

JJ commented Feb 9, 2018 via email

@JJ
Copy link
Contributor

JJ commented Feb 9, 2018

Well, that particular page is written in markdown:
screenshot from 2018-02-09 19 54 22
And that one is only for environment variables. There's no page that covers the same area as the proposed file. I'll go and create one, and kinda dump everything there. Then let's see what's the reaction...

@JJ
Copy link
Contributor

JJ commented Feb 9, 2018

Well, took me a good while, basically the 24 minutes from my previous message, with one issue #1763 created in the process, but there it is https://github.com/rakudo/rakudo/wiki/Running-rakudo-from-the-command-line Can we proceed?

JJ added a commit that referenced this issue Feb 10, 2018
And works with links to it pointing them to a reasonable place. Refs #949
@JJ JJ closed this as completed in 0c678b4 Feb 10, 2018
JJ added a commit that referenced this issue Feb 10, 2018
In fact, its only use in this documentation is commented out, and a
real use was in the file that was removed in #949. Anyway, it's used
throughout the documentation and I think it's fine to include just
this little definition. Refs #1763.
@zoffixznet
Copy link
Contributor

zoffixznet commented Feb 13, 2018

I think this Issue a bit outlived itself. When it was created, only a couple of Rakudo-specific env vars were listed on it.

The latest version of the page, before it got removed, contained many more vars, including language env vars like PERL6_TEST_DIE_ON_FAIL, which should be in language docs, not in a wiki of some particular implementation. So at least those ones should be brought back.

As for the general moving of RAKUDO_ vars to the wiki, I'm not exactly sure how it helps our users to require them to go to some third-party resource and try to find the required information among pages like "MOLD Removal SQUASHathon" and "save me from texas".

@zoffixznet zoffixznet reopened this Feb 13, 2018
@AlexDaniel
Copy link
Member

find the required information among pages like "MOLD Removal SQUASHathon" and "save me from texas".

Heh. That's a good point.

@JJ
Copy link
Contributor

JJ commented Feb 13, 2018

Maybe we should change the issue title to "Create language environment variables page"? What the title said was precisely what was done, move it to the wiki.

@AlexDaniel
Copy link
Member

@JJ please feel free to edit titles in general, and also any of my comments if you feel necessary.

@JJ
Copy link
Contributor

JJ commented Feb 13, 2018

@AlexDaniel if what we want is to have a new page, I think it's much better to open a new issue saying just that. @zoffixznet , what do you think? Let what's been closed stay closed :-)

@AlexDaniel
Copy link
Member

@JJ Yes, that's the right way to do it I think. FWIW that's even written as a recommendation for squashathons:

If the ticket is asking for more than one thing, replace with new smaller tickets and close it. If you see a lot of out-of-place discussion, try to understand the main point and create a new highly-specific ticket to replace it.

So creating a new ticket usually makes things go easier, but having a link to the previous ticket never hurts I think.

@JJ
Copy link
Contributor

JJ commented Feb 13, 2018

... and the wiki :-)
(I'll close this when I -- or someone else -- creates the ticket(s))

@ghost
Copy link

ghost commented Feb 14, 2018

Wouldn't it make more sense to just update the original file this all seems to be copy-pasted from, https://github.com/rakudo/rakudo/blob/master/docs/running.pod? I even mentioned it was perfectly good material going to waste in Raku/user-experience#9, but got no response.

@JJ
Copy link
Contributor

JJ commented Feb 14, 2018 via email

@ghost
Copy link

ghost commented Feb 14, 2018

It would be useful to keep that file up to date, since every rakudo release tarball already contains it.

@coke coke added good first issue If you want to dive in, this would be a good place to start and removed LHF labels Apr 9, 2018
@JJ JJ changed the title Move programs/00-running to rakudo wiki Create page for environment variables the interpreter uses Apr 14, 2018
@JJ JJ removed the JJ TPF Grant label May 14, 2018
JJ added a commit that referenced this issue May 31, 2018
This would go towards solving #949. It's a page adapted from the
Rakudo one, which is linked, along with author attribution.
@JJ JJ closed this as completed in 3de171f May 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue If you want to dive in, this would be a good place to start
Projects
None yet
Development

No branches or pull requests

4 participants