Project

General

Profile

Feature #976

Improve environment variable names

Added by Justin Lemkul almost 5 years ago. Updated almost 3 years ago.

Status:
Closed
Priority:
Normal
Category:
documentation
Target version:
Difficulty:
uncategorized
Close

Description

While documenting various environment variables, I encountered several that have very generic names that could be improved by making them more descriptive. Many are involved in the QM interface, but there are others. Some of the env. vars. that could be made more explicit (in my opinion) are:

ACC
BASENAME
MEM
NCPUS
SASTEP
STATE
TOTAL
VERBOSE
WHERE
LOGO

Even prefixing them with GMX_ and some indication of how they're used (e.g. GMX_QM_ORCA_BASE instead of BASENAME, GMX_ENER_VERBOSE instead of VERBOSE, etc) would make them much better. I will suggest this for inclusion in 5.0/master to avoid largely cosmetic changes to the code.

Associated revisions

Revision da96f04b (diff)
Added by Rossen Apostolov almost 3 years ago

Cleanup environment variables.

Renamed variables to more descriptive names and
removed unused ones.

Fixes #976.

Change-Id: I0c17443c93efe581bf728f783893181e5a7f8ed8

History

#1 Updated by Justin Lemkul almost 5 years ago

  • Assignee deleted (Justin Lemkul)

#2 Updated by Mark Abraham about 3 years ago

  • Target version changed from 5.0 to future

#3 Updated by Gerrit Code Review Bot almost 3 years ago

Gerrit received a related patchset '1' for Issue #976.
Uploader: Rossen Apostolov ()
Change-Id: I0c17443c93efe581bf728f783893181e5a7f8ed8
Gerrit URL: https://gerrit.gromacs.org/3588

#4 Updated by Rossen Apostolov almost 3 years ago

  • Status changed from New to Fix uploaded

This should be a rather extensive list of such variables.

#5 Updated by Rossen Apostolov almost 3 years ago

  • Status changed from Fix uploaded to Resolved
  • % Done changed from 0 to 100

#6 Updated by Erik Lindahl almost 3 years ago

  • Status changed from Resolved to Closed

#7 Updated by Teemu Murtola almost 3 years ago

  • Assignee set to Rossen Apostolov
  • Target version changed from future to 5.0

Also available in: Atom PDF