Documentation/Labs/FHSCompliantDirectoryStructure - Revision history

JChris.FillionR at 22:41, 10 April 2014

2014-04-10T22:41:05Z

Matthew.woehlke at 20:52, 10 April 2014

2014-04-10T20:52:24Z

JChris.FillionR: Created page with 'The current install tree structure as documented on Documentation/Nightly/Developers is not compliant with the [http://www.pathname.com/fhs/|File Hierarchy Standard]. This pa…'

2014-04-10T16:58:36Z

Created page with 'The current install tree structure as documented on Documentation/Nightly/Developers is not compliant with the [http://www.pathname.com/fhs/|File Hierarchy Standard]. This pa…'

New page

The current install tree structure as documented on [[Documentation/Nightly/Developers]] is not compliant with the [http://www.pathname.com/fhs/|File Hierarchy Standard]. This page aims at documentation how the structure could be updated.

From Matthew Woehlke - April 10, 2014:
<pre>
I was thinking more about the bin/Python / bin/python-real issue, and got to thinking, it would be nice if Slicer did a better job following the FHS. Right now, anyone trying to install Slicer to a standard location (especially /usr, but even /usr/local) would make a mess of their file system.

To remedy this, I would suggest the following changes:

- move /Slicer [1] to /bin/
- move /bin/Python [2] to one of:
- /lib/python-${PyVer}/site-packages
- /lib/python-${PyVer}/site-packages/slicer${VerMajor}
- /share/Slicer-${Ver}/
- ...and move SlicerWizard to /lib/python-${PyVer}/site-packages
- move /lib/Python/* [3] to /
- move /lib/TclTk/* [3] to /
- move /lib/QtPlugins [4] to /lib/Slicer-${Ver}/
- move /lib/Slicer*/<third party libs> [3] to /lib/
- move /bin/Slicer{LauncherSettings.ini,SplashScreen.png} [5] to
/share/Slicer-${Ver}/

Honoring LIB_SUFFIX would also be nice.

Ideally, SlicerLauncherSettings.ini and SlicerSplashScreen.png (currently in /bin) should also be elsewhere (possibly /etc and /share, respectively, or both under /share), but that might be difficult due to how the launcher is set up. (OTOH the first item may require launcher changes anyway, in which case it would be better to go ahead and move them.)

What do you think?

Footnotes:

1. FHS (e.g. 3.1) strongly discourages adding entries to / or /usr. Anyway, this clearly should be in /bin so that it is in a reasonable PATH. On UNIX systems where PREFIX=/opt/... (or perhaps as a CMake option), it might be okay to install a symlink in PREFIX. On Windows, a shortcut could be used similarly.

2. 3.4.2 forbids subdirectories in /bin. While not stated explicitly for /usr/bin, many systems now symlink /bin to /usr/bin, implicitly forwarding the prohibition.) Additionally, the files contained herein are not executables but are library code that clearly belong under /lib or /share.

3. For a standard installation, all products should be installed to ${PREFIX}; <product>_PREFIX=${Slicer_PREFIX}/lib/<product> is non-standard.

4. Convention for third party Qt plugins (e.g. see KDE) is a subdirectory (e.g. plugins) of /lib/<product>.

5. These non-executable files do not belong in /bin. While the .ini could possible be placed in /etc, this requires special handling in the case that PREFIX=/usr; /share/Slicer-${Ver} also seems like a reasonable location and does not have this issue.
</pre>

← Older revision		Revision as of 22:41, 10 April 2014
Line 1:		Line 1:
−	The current install tree structure as documented on [[Documentation/Nightly/Developers]] is not fully compliant with the [https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard Filesystem Hierarchy Standard]. This page aims at ~~documentation~~ how the structure could be updated.	+	The current install tree structure as documented on [[Documentation/Nightly/Developers]] is not fully compliant with the [https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard Filesystem Hierarchy Standard]. This page aims at documenting and discussing how the structure could be updated.

	== Rationale ==		== Rationale ==

@@ Line 1: / Line 1: @@
-The current install tree structure as documented on [[Documentation/Nightly/Developers]] is not compliant with the [http://www.pathname.com/fhs/|File Hierarchy Standard]. This page aims at documentation how the structure could be updated.
+The current install tree structure as documented on [[Documentation/Nightly/Developers]] is not fully compliant with the [https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard Filesystem Hierarchy Standard]. This page aims at documentation how the structure could be updated.
-From Matthew Woehlke  - April 10, 2014:
+For reasons that hopefully do not require enumeration, it is desirable for Slicer to install in a reasonable manner to a system standard prefix, e.g. <tt>/usr/local</tt> or even <tt>/usr</tt>. Ultimately, it would be very cool if distributions were able to package slicer, for which reasonable FHS compliance is a requirement.
-To remedy this, I would suggest the following changes:
+== Proposal ==
-- move /Slicer [1] to /bin/
+(Originally by Matthew Woehlke - April 10, 2014)
-Honoring LIB_SUFFIX would also be nice.
+* move <tt>/Slicer</tt><sup>[[#fn1|[1]]]</sup> to <tt>/bin/</tt>
-Ideally, SlicerLauncherSettings.ini and SlicerSplashScreen.png (currently in /bin) should also be elsewhere (possibly /etc and /share, respectively, or both under /share), but that might be difficult due to how the launcher is set up. (OTOH the first item may require launcher changes anyway, in which case it would be better to go ahead and move them.)
+(As a side note, honoring LIB_SUFFIX also would be nice. This is common idiom in e.g. [http://www.fedoraproject.org Fedora] packaging to install libraries to <tt>lib64</tt> rather than <tt>lib</tt>, when building for architectures where that is appropriate.)
-What do you think?
+=== Footnotes ===
-Footnotes:
+Section references in the above are given for [http://refspecs.linuxfoundation.org/FHS_2.3/fhs-2.3.pdf the PDF version of FHS 2.3]. (The HTML version unfortunately does not number sections.)