Base directory standard compliance #1369
Merged
Conversation
This file contains 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
The application data directory standards on Windows and Mac use organization names in the directory paths. On Windows, this is a path like `%AppData%\OrgName\AppName`, while on Mac it is a path like `$HOME/Library/Application Support/com.example.AppName`, using a Java-like embedding into DNS, for Mac application bundles. Namada does not provide a Mac application bundle, so the DNS embedding is unnecessary, and "heliax.com" is not the correct domain name in any case. Therefore, use an empty string for the domain qualifier. The correct organization name for Namada might be "Namada" if one were necessary, but it would be redundant with the application name. Therefore, use an empty string for the organization name. This results in paths like `%AppData\namada` for Windows and `$HOME/Library/Application Support/namada` for Mac. The Unix directory name, `$XDG_DATA_HOME/namada`, is unaffected. A useful citation follows: File System Programming Guide (for Mac): https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html (see Table 1-3; note that it specifies "your app's bundle identifier or your company" but many organizations or communities, like Namada, are not companies; we can read this broadly to encompass "Namada", and it is not unheard of to use a simple application name here.)
By Mac and Windows convention, application names are upcased, while by Unix convention they are downcased. The directories crate will downcase it on Unix for us; therefore, upcase it here.
Closed
The CLI help needs to reflect the updated default data dirs.
juped
force-pushed
the
ray/base-directory-organizations
branch
from
87a9294
to
5367af8
Compare
Closed
tzemanovic
previously approved these changes
May 15, 2023
juped
added a commit
that referenced
this pull request
May 15, 2023
…se-directory-organizations' (#1369) into maint-0.15 * ray/base-directory-windows-local: changelog: add #1368 apps/config: use non-roaming profile on Windows * ray/base-directory-organizations: changelog: add #1369 apps/cli: update default data dirs in cli help apps/config: upcase "Namada" for data directories apps/config: use blank domain and organization
juped
added a commit
that referenced
this pull request
May 15, 2023
* main: changelog: add #1368 changelog: add #1369 changelog: add #1366 apps/cli: update default data dirs in cli help apps/config: use non-roaming profile on Windows apps/config: upcase "Namada" for data directories apps/config: use blank domain and organization more places changed the base dir where i could find it fix: format fix: base ledger location contrib: add more detail about desired changelog descriptions contrib: update cmd to only show unique changelog sections comet-bft release: bump supported cargo-release version to 0.24.4 More minor changes Alter multisig specs slightly Update mdbook-katex version Minor nits in execution model Add links to subsections changed unrendered emojis
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
apps/config: use blank domain and organization
The application data directory standards on Windows and Mac use
organization names in the directory paths. On Windows, this is a path
like
%AppData%\OrgName\AppName, while on Mac it is a path like$HOME/Library/Application Support/com.example.AppName, using aJava-like embedding into DNS, for Mac application bundles.
Namada does not provide a Mac application bundle, so the DNS embedding
is unnecessary, and "heliax.com" is not the correct domain name in any
case. Therefore, use an empty string for the domain qualifier.
The correct organization name for Namada might be "Namada" if one were
necessary, but it would be redundant with the application name.
Therefore, use an empty string for the organization name.
This results in paths like
%AppData\namadafor Windows and$HOME/Library/Application Support/namadafor Mac.apps/config: upcase "Namada" for data directories
By Mac and Windows convention, application names are upcased, while
by Unix convention they are downcased. The directories crate will
downcase it on Unix for us; therefore, upcase it here.
apps/cli: update default data dirs in cli help
The CLI help needs to reflect the updated default data dirs.