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

Modified & enhanced docs wrt paths #66

Merged
merged 10 commits into from
Jul 17, 2021

Conversation

93-infinity
Copy link
Contributor

Original without modifying your docs: https://pad.snopyta.org/ykmEOXasS5GiaEF1f9eymw

Pull request because:

Issue 1 - replace references to long paths in cygwin/wsl subsections

Aside from the WSL-specific instructions, most of the stuff relating to long paths (background, workarounds, video player apps) are not specific to WSL, and equally apply to the Cygwin-Git-Bash section. I've stripped all mentions of long paths from the new WSL & existing Cygwin-Git-Bash sections. This keeps both parts purely install-related. A common section redirecting to docs/LongPaths is added to them both, with a cliffhanger (videos won't be playable) to entice users to actually read it

Issue 2 - Modify README.md

  • remove your references to path length limit
  • details the fate of the Windows version (mainly your text, use some verbiage from the Cygwin-Git-Bash section)
  • WSL is not the only thing that bypasses path length limits, removed this parts - is it? check (I did not check if cygwin does)
  • effect of path length on playback of videos - removed
  • Add the same common section redirecting to docs/LongPaths as wsl/cygwin install instructions, with same cliffhanger (videos won't be playable) to entice users to actually read it

Issue 3 - Create docs/LongPaths.md

  • stuff everything about long paths here, to avoid cluttering up README.md

Change HardLinkShell description
clarify: files are difficult, not impossible, to manipulate
fix readability
make similar sections consistent
elaborate workarounds
discourage users from setting up xserver
clarify long paths not being completely un-manipulatable
clarify implication that mc is not a linux program
link to hardlinkshell
explain explorer not supporting long paths even with new group policy
further resources: tools and further reading
minor text changes, present tense, readability, specify path length limits apply to windows only
Worse at spelling than thefrenchghosty
@93-infinity
Copy link
Contributor Author

Outstanding issue, if cygwin doesn't support long paths (what's the point of using it, then), then simply add note in readme in the future to specify only WSL's support.

- modify wsl/cygwin heading levels to be consistent with thefrenchghosty's existing files in docs folder
- Clarify long-path'ed files as not being corrupt or problematic
- tell the user they can organize files as they wish, but caveat emptor
- exercise restraint by not adding section telling user to consider using linux
@93-infinity
Copy link
Contributor Author

Still has some typos

no more changes
@TheFrenchGhosty
Copy link
Owner

Sorry that it took me so long to get to it.

Thanks a lot for this really detailed documentation enhancement! This will definitely help windows users.

@TheFrenchGhosty TheFrenchGhosty merged commit 5638036 into TheFrenchGhosty:master Jul 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants