Merge dirs-sys and directories to dirs #3
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix wrong project cache directory documentation for Windows.
... and fix wrong env var names in README (...DIR -> ...HOME)
... remove executable_dir on macOS.
...ProjectDirs, drop project_ prefix from ProjectDirs functions, turn all user dir paths into options.
Update README, more tests and fixes, implementation should now produce paths following the standards on all three platforms.
Documentation:
- Added missing documentation on impls and fns, pretty much everything
public should be documented now.
- Update README and documentation on Windows changes
Windows:
- BaseDirs::cache_dir points to {FOLDERID_LocalAppData},
not {FOLDERID_LocalAppData}\cache\
- ProjectDirs now point to sub-directories on Windows:
- ProjectDirs.cache_dir: {FOLDERID_LocalAppData}\_project_path_\cache\
- ProjectDirs.config_dir: {FOLDERID_RoamingAppData}\_project_path_\config\
- ProjectDirs.data_dir: {FOLDERID_RoamingAppData}\_project_path_\data\
- ProjectDirs.data_local_dir: {FOLDERID_LocalAppData}\_project_path_\data\
- See dirs-dev/directories-rs#9 for the reasoning behind the changes.
... UserDirs (user-facing dirs).
This also improves the semantics, as we now handle missing, deactivated or invalid user dirs correctly instead of returning $HOME. Co-authored-by: Simon Ochsenreither <simon@ochsenreither.de>
Prior to this change, only the Linux and Redox OS targets would compile an implementation. This change broadens the list of targets which will conditionally compile the `user_dir` and `user_dirs` functions such that all Unix family targets (except macOS and iOS) can use this implementation.
Redox now lives in the unix family. Rework the cfgs to account for this. Also, std::env was not imported for redox.
This is to allow the crate to compile with rustc 1.13.
... by pinning cfg-ig to 0.1.9, as 0.1.10 introduced changes that broke the build.
prepare for publishing under new name
Contributor
Author
|
With @Dylan-DPC approval, I'll merge this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
17 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I used
git-subtreeto do the work here (like rust-lang/rust#70655).The commit numbers after the merge should be the same.
Only some commits of mine at the end of this PR need reviewing.
Question:
Should we keep the old repository for dirs-sys and directories?