Skip to content

Commit

Permalink
Update executable name for USAGE and EXAMPLE.
Browse files Browse the repository at this point in the history
  • Loading branch information
@nealkruis
nealkruis committed Oct 7, 2014
1 parent 8e7cb54 commit 999ea96
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/EnergyPlus/CommandLineInterface.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,9 @@ namespace CommandLineInterface{
ezOptionParser opt;

opt.overview = VerString;
opt.example = "EnergyPlus -i custom.idd -w weather.epw -d output/ -p prefix -r input.idf";

This comment has been minimized.

Sign in to view

Copy link
@Myoldmopar

Myoldmopar Oct 8, 2014

Member

Although I don't expect the executable name to change, I've seen a lot of programs just use a cleaned (basename) argv[0] in case it does for some reason. What are your thoughts on doing that here?

I'm getting pretty excited to see this in action...

This comment has been minimized.

Sign in to view

Copy link
@nealkruis

nealkruis Oct 8, 2014

Author Member

As part of our task with creating a conventional command line interface, we are changing the executable to be all lowercase as it is common practice on *IX systems. This will be fully backwards compatible with the ways EnergyPlus is currently called from any script or the command line.

This convention is described somewhat here: http://programmers.stackexchange.com/questions/186313/lowercase-in-linux-file-names

This comment has been minimized.

Sign in to view

Copy link
@Myoldmopar

Myoldmopar Oct 8, 2014

Member

I'm all for changing the filename back. The capitalized binaries are, umm, out of place, over here. I'm curious about your backwards compatible statement. If people have scripts set up to run v8.1 on Linux, the binary "EnergyPlus" is in their path. Their scripts may be broken moving forward, though it is a very easy fix.

I'm not interested in debating the decision, or belaboring anything. More thinking about notes we may need to add to the README or something to capture the change.

This comment has been minimized.

Sign in to view

Copy link
@nealkruis

nealkruis Oct 8, 2014

Author Member

On Windows and Mac binaries are case-insensitive. For linux, we will package an uppercase symlink to the lowercase binary.

This comment has been minimized.

Sign in to view

Copy link
@Myoldmopar

Myoldmopar Oct 8, 2014

Member

Nice, thanks!
opt.example = "energyplus -i custom.idd -w weather.epw -d output/ -p prefix -r input.idf";

opt.syntax = "EnergyPlus [options] [input file]";
opt.syntax = "energyplus [options] [input file]";

opt.add("", 0, 0, 0, "Display this message", "-h", "--help");

Expand Down

4 comments on commit 999ea96

@nrel-bot
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1277852-CommandLineInterface (nealkruis) - x86_64-MacOS-10.9-clang: Tests Failed

Build Badge Test Badge

@nrel-bot
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1277852-CommandLineInterface (nealkruis) - x86_64-MacOS-10.9-clang-Debug: Tests Failed

Build Badge Test Badge

@nrel-bot
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1277852-CommandLineInterface (nealkruis) - x86_64-Linux-Ubuntu-14.04-gcc-4.8: Build Failed

Build Badge Test Badge

@nrel-bot
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1277852-CommandLineInterface (nealkruis) - x86_64-Linux-Ubuntu-14.04-cppcheck-1.61: OK (0 of 0 tests passed)

Build Badge

Please sign in to comment.