InsightSoftwareConsortium / InsightSoftwareConsortium/ITKSphinxExamples

Sort CMake install files consistently in `CMakeLists.txt` files

Ouverte
#264 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Good first issue type:Enhancement
Langage dominant
Jupyter Notebook
Étoiles
59
Forks
70
Merge moyen
1 j 15 h
PR mergées (30 j)
12

Description

The file list saved to the `FILES` variable to be provided to the CMake `install ` command should follow the same sorting convention to improve the consistency and readability of the `CMakeLists.txxt` files.

Currently we find both instances:
```
install(FILES Code.cxx CMakeLists.txt Code.py
```
and
```
install(FILES Code.cxx Code.py CMakeLists.txt
```

It probably makes sense to group together or list consecutively all source code files (second instance) and have `CMakeLists.txt` either at the beginning (`install(FILES CMakeLists.txt Code.cxx Code.py`) or at the end (second instance). Although the former is not used, since `CMakeLists.txt` will always be present, it is "easier" to append a filename rather than inserting it.

This is an easy change to do (although it requires manual work unless some clever script to automate the process is developed) provided that we reach consensus or establish a criterion.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Piste de recherche

Search the repository's CMakeLists.txt files for install(FILES ...) lists and compare the existing ordering conventions. First establish whether CMakeLists.txt belongs at the beginning or end, then reorder the lists consistently and review the changes for accidental file omissions.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
cmake
Domaine
build-system
Type d'issue
Refactorisation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.