msys2 / msys2/msys2.github.io

add documentation of MSYS variable settings

Open
#152 6 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
3.3k
Forks
446
Avg merge
2h 16m
Merged PRs (30d)
1

Description

This is a proposal of something I want to add somewhere, but haven't figured out exactly how/where. I want to make documentation of the MSYS environment variable options that differ from upstream's https://cygwin.com/cygwin-ug-net/using-cygwinenv.html. I'm responsible for two of them now ☹️ (winjitdebug which I went into detail about using on #116, and now nonativeinnerlinks which doesn't really merit its own page). I'd almost want to patch the docs in msys2-runtime to document new flags, but as far as I know nothing's done with that to put it anywhere a user's likely to find it.

/cc @dscho as Git for Windows either already has something like this or would benefit from it also.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the upstream Cygwin environment-variable documentation with the MSYS-specific behavior described in this issue and discussion #116. Review how msys2-runtime documentation is currently surfaced, then identify a discoverable location for the MSYS options; done means documenting winjitdebug and nonativeinnerlinks and explaining their differences from upstream.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.