I’ve updated the Design (v11)
removing the angled brackets (<>) from the default keyword.
Thanks@bayucan, I think this will be clearer (hopefully).
From the standpoint of being parseable by a human, plain “default” is still hard to understand. Please make this into a non-word. I suggest something like default_loc, or anything that automatically signals that the user needs to look it up.
@agurban : can you suggest anything more straightforward than “default”? It seemed intuitive to me. The site will still need to look up what “default” means, which is the default directory used by PBS for (currently, user’s home directory). Also, looking at man pages, I can see the entry could now look like this:
$jobdir_root < default | <stage directory path> > [shared]
It’s unfortunate that we use the <> to enclose the OR option, but we also put in angled brackets the argument .
On most Unix/Linux systems, both “~” and “$HOME” represent the user’s home directory.
Nothing is perfect (both the above would look like PBS is doing variable substitution, which might fool folks into variable substitution would also work elsewhere in the config file, etc.
Not sure it’s possible now (without backward compatibility issues), but another option would be to replace the “shared” option with a config setting, e.g., a separate line with “$jobdir_root_shared” (or $jobdir_root_shared true").
On most Unix/Linux systems, both “~” and “$HOME” represent the user’s home directory.
Nothing is perfect (both the above would look like PBS is doing variable substitution, which might fool folks into variable substitution would also work elsewhere in the config file, etc.
It’s possible that later on, the default could change to not user’s home directory. So we can’t really force something like $HOME.
Not sure it’s possible now (without backward compatibility issues), but another option would be to replace the “shared” option with a config setting, e.g., a separate line with “$jobdir_root_shared” (or $jobdir_root_shared true").
Yes, the “shared” option has been implemented and published. Backward compatibility could be a problem.
The word “default” alone is too generic. Default what? Give them a clue, such as “default_dir”.
Let’s go with PBS_USER_HOME. It most accurately describes the behavior and is very unlikely to cause collision with existing configurations.
Ok, PBS_USER_HOME it is.
Updated Design (v12), changing “default” to “PBS_USER_HOME”.