aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Dewar <alexdewar@users.noreply.github.com>2018-10-16 11:43:36 +0100
committerRobert Schumacher <roschuma@microsoft.com>2018-10-16 03:43:36 -0700
commit9cf7cfeeb9c7cf393924bb2e962539f31f086ca5 (patch)
tree3617788df792582b46ff9229872fa4e8cd72cfa0
parentd798fd304018452c2c850e9f5aa4b54e389ca30f (diff)
downloadvcpkg-9cf7cfeeb9c7cf393924bb2e962539f31f086ca5.tar.gz
vcpkg-9cf7cfeeb9c7cf393924bb2e962539f31f086ca5.zip
Display names of environment variables correctly for non-Windows (#4471)
platforms in help Currently vcpkg displays environment variable names in the help as %VARIABLENAME% on non-Windows platforms, where it should be $VARIABLENAME. This patch adds a macro to fix this.
-rw-r--r--toolsrc/src/vcpkg/help.cpp13
1 files changed, 10 insertions, 3 deletions
diff --git a/toolsrc/src/vcpkg/help.cpp b/toolsrc/src/vcpkg/help.cpp
index 743619937..2b409373d 100644
--- a/toolsrc/src/vcpkg/help.cpp
+++ b/toolsrc/src/vcpkg/help.cpp
@@ -7,6 +7,13 @@
#include <vcpkg/install.h>
#include <vcpkg/remove.h>
+// Write environment variable names as %VARIABLE% on Windows and $VARIABLE in *nix
+#ifdef _WIN32
+#define ENVVAR(VARNAME) "%%" #VARNAME "%%"
+#else
+#define ENVVAR(VARNAME) "$" #VARNAME
+#endif
+
namespace vcpkg::Help
{
struct Topic
@@ -93,7 +100,7 @@ namespace vcpkg::Help
"%s" // Integration help
"\n"
" vcpkg export <pkg>... [opt]... Exports a package\n"
- " vcpkg edit <pkg> Open up a port for editing (uses %%EDITOR%%, default 'code')\n"
+ " vcpkg edit <pkg> Open up a port for editing (uses " ENVVAR(EDITOR) ", default 'code')\n"
" vcpkg import <pkg> Import a pre-built library\n"
" vcpkg create <pkg> <url>\n"
" [archivename] Create a new package\n"
@@ -104,10 +111,10 @@ namespace vcpkg::Help
"\n"
"Options:\n"
" --triplet <t> Specify the target architecture triplet.\n"
- " (default: %%VCPKG_DEFAULT_TRIPLET%%, see 'vcpkg help triplet')\n"
+ " (default: " ENVVAR(VCPKG_DEFAULT_TRIPLET) ", see 'vcpkg help triplet')\n"
"\n"
" --vcpkg-root <path> Specify the vcpkg root directory\n"
- " (default: %%VCPKG_ROOT%%)\n"
+ " (default: " ENVVAR(VCPKG_ROOT) ")\n"
"\n"
"For more help (including examples) see the accompanying README.md.",
Commands::Integrate::INTEGRATE_COMMAND_HELPSTRING);