cms-gem-daq-project / gem-plotting-tools

Repository for GEM commissioning plotting tools
GNU General Public License v3.0
1 stars 26 forks source link

Install the man pages #139

Closed lmoureaux closed 5 years ago

lmoureaux commented 6 years ago

Description

This PR modifies the Makefile and setup script to install the man pages. They are installed at $BASE/share/man, where $BASE is as follows:

Man pages in the virtualenv can be accessed by setting the correct $MANPATH.

[outdated] A side-effect of this change is that I figured out how to modify the default setuptools install location. All scripts and macros are now installed in $BASE/bin. This means that virtualenv can take care of updating the $PATH (system-wide installs still need a setup script). [/outdated]

Another side-effect is that I corrected the license information in the package metadata. It was saying "MIT" while the LICENSE file always contained the text of GPLv3 (there is no way to change back to MIT without contacting every single contributor).

The setup script and developer documentation will need to be updated to use the $MANPATH.

Downsides

As a result of these downsides and my inability to fix them shortly, this PR is provided more as a list of commits to be cherry-picked.

Types of changes

Motivation and Context

How Has This Been Tested?

Since I don't have access to a rpm-based machine and I don't want to install one, I couldn't check that the rpm package installs cleanly.

Checklist:

lmoureaux commented 6 years ago

avoiding putting things in macros into /opt/cmsgemos/bin

May I ask what's the rationale for the difference between scripts and macros in this project?

lmoureaux commented 6 years ago

I would have to go back in time to figure out why a given license was (probably arbitrarily) chosen for this project

Commit 3d58f5d2 by... @jsturdy. The commit message ("Initial commit") isn't helpful in telling how the license was chosen.

FYI:

jsturdy commented 6 years ago

May I ask what's the rationale for the difference between scripts and macros in this project?

Mainly, it is to isolate the key executable parts (analyzing scans, which should go in /opt/cmsgemos/bin) from random plotting and style macros (can still be on the PATH for ease of use, provided PATH is modified to include the macros directory)

Further down the road, much of this will be replaced with console_scripts and entry_points, but that is a minor priority

lmoureaux commented 6 years ago

Removed the controversial move to a more standard behavior using standard tools; the rpm package will now install man pages in /usr/share. Updated the first post accordingly.

lmoureaux commented 5 years ago

Comments have been addressed and I'm waiting for another review.