Skip to content

Commit

Permalink
Add small revisions to comments/docs to enhance concept clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
jhiemstrawisc committed Nov 27, 2024
1 parent fe03cc4 commit 3f979ab
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -953,9 +953,9 @@ func SetServerDefaults(v *viper.Viper) error {
v.SetDefault(param.Origin_RunLocation.GetName(), filepath.Join("/run", "pelican", "xrootd", "origin"))
v.SetDefault(param.Cache_RunLocation.GetName(), filepath.Join("/run", "pelican", "xrootd", "cache"))

// Several deprecated keys point to Cache.StorageLocation, and by the time here we've already mapped those
// keys in handleDeprecatedConfig(). To prevent overriding potentially-mapped deprecated keys, we only re-set
// the default here if this key is not set.
// Several deprecated keys point to Cache.StorageLocation, and by the time we reach this section of code, we should
// have already mapped those keys in handleDeprecatedConfig(). To prevent overriding potentially-mapped deprecated keys,
// we only re-set he default here if this key is not set.
if !v.IsSet(param.Cache_StorageLocation.GetName()) {
v.SetDefault(param.Cache_StorageLocation.GetName(), filepath.Join("/run", "pelican", "cache"))
}
Expand Down Expand Up @@ -1010,9 +1010,9 @@ func SetServerDefaults(v *viper.Viper) error {

v.SetDefault(param.Origin_GlobusConfigLocation.GetName(), filepath.Join(runtimeDir, "xrootd", "origin", "globus"))

// Several deprecated keys point to Cache.StorageLocation, and by the time here we've already mapped those
// keys in handleDeprecatedConfig(). To prevent overriding potentially-mapped deprecated keys, we only re-set
// the default here if this key is not set.
// Several deprecated keys point to Cache.StorageLocation, and by the time we reach this section of code, we should
// have already mapped those keys in handleDeprecatedConfig(). To prevent overriding potentially-mapped deprecated keys,
// we only re-set he default here if this key is not set.
if !viper.IsSet(param.Cache_StorageLocation.GetName()) {
viper.SetDefault(param.Cache_StorageLocation.GetName(), filepath.Join(runtimeDir, "cache"))
}
Expand Down
2 changes: 1 addition & 1 deletion docs/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1068,7 +1068,7 @@ components: ["localcache"]
############################
name: Cache.StorageLocation
description: |+
An absolute path to the directory where xrootd will create its default namespace, `meta`, and `data` directories. For example,
An absolute path to the directory where xrootd will create its default `namespace`, `meta`, and `data` directories. For example,
setting `Cache.StorageLocation=/run/pelican/cache` without specifying further `Cache.DataLocations` or `Cache.MetaLocations`
values will result in the cache creating a directory structure like:
```
Expand Down

0 comments on commit 3f979ab

Please sign in to comment.