Problem 2022 - Installs files beginning with period into the examples folder
Summary: Installs files beginning with period into the examples folder
Status: RESOLVED WONTFIX
Alias: None
Product: Examples/Basic and Novice
Classification: Unclassified
Component: general (show other problems)
Version: other
Hardware: All All
: P4 minor
Assignee: Ivana.Hrivnacova
URL:
Depends on:
Blocks:
 
Reported: 2017-12-15 02:38 CET by yuri
Modified: 2018-02-07 15:04 CET (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this problem.
Description yuri 2017-12-15 02:38:23 CET
It installs some README files with periods, ex. .README.HowToRun, and .doxygen directory.

It isn't clear why doxygen should be installed as examples and not as documentation.

Files beginning with period aren't justified in the examples folder.
Comment 1 asai 2017-12-15 02:51:13 CET
Please add more information. Which version as you installing? Have you followed our installation instruction? Could you successfully install Geant4 itself?
Kind regards,
Makoto
Comment 2 yuri 2017-12-15 02:53:56 CET
Version 10.4
Using the FreeBSD ports framework to install, it follows standard procedures for all cmake-based projects.
Comment 3 yuri 2017-12-15 02:54:41 CET
And Geant4 itself install fine.
Comment 4 Ivana.Hrivnacova 2017-12-15 14:46:58 CET
The .README* files are used by Doxygen to generate the examples source code documentation. As they include some Doxygen keywords we preferred to provide them in addition to the "plain" README files, which are just text files, and hide them from the user with "."
They are in place since long time (I checked that it's already the case in 9.6).
Could you, please, let us know, why you see this as a problem?

Thank you,
Comment 5 yuri 2017-12-15 18:55:18 CET
.README.HowToRun is the pre- preprocessing version of README.HowToRun.
Users will not do any preprocessing themselves, the very meaning of preprocessing is to generate the final version. Therefore, installing .README.HowToRun is just meaningless from the user's standpoint.
Comment 6 Ivana.Hrivnacova 2018-02-07 15:04:39 CET
It’s a good thing to only install what’s explicitly needed, but in this case it’s incredibly low priority, as the .README.txt files do not take excess disk space and also do not affect the functionality of Geant4 or applications. 
If it’s a real issue, the files can always be removed by hand.
Please, let us know if you really get problems due to this.