reworked module template, traslation in english
This commit is contained in:
@@ -1,48 +1,44 @@
|
|||||||
# Template générique à utiliser comme modèle pour de nouveaux modules #
|
# Generic templateque to use as a model for new modules creation #
|
||||||
# #
|
# #
|
||||||
# !!! ATTENTION : les modules ne sont pas supposé contenir de code spécifique #
|
# !!! ATTENTION : modules are not supposed to contains any specific code for #
|
||||||
# !!! pour une distribution ou une autre. Utiliser les fichiers de #
|
# !!! a distribution or a other. Please use configuration files #
|
||||||
# !!! configurations pour introduire du code spécifique. #
|
# !!! to introduce any specific code. #
|
||||||
# #
|
# #
|
||||||
# @template@ doit être remplacé par le nom de votre module qui doit être nomé #
|
# @template@ must be replaced by the name of your module. It have to be named #
|
||||||
# @template@.sh. Vous pouvez automatiquement créer votre nouveau module avec #
|
# @template@.sh. You can automaticallly create your new module using the #
|
||||||
# la commande suivante : #
|
# following command : #
|
||||||
# #
|
# #
|
||||||
# sed -e "s/@template@/nom_module/g" -e "/^# .*/d" -e "s/^##/# /" template > nom_module.sh
|
# sed -e "s/@template@/mod_name/g" -e "/^# .*/d" -e "s/^##/# /" template > mod_name.sh
|
||||||
# #
|
# #
|
||||||
# La versionnage suit des règles standards. Numéroté ainsi en x.y.z : #
|
# Versioning iis following standard rules. Numbered as x.y.z: #
|
||||||
# * x : incrémenté en cas de transformation profonde ou ajouts majeurs #
|
# * x : increased on deep changes, rewrites or major additions #
|
||||||
# * y : incrémenté en cas d'ajout mineur de fonctionnalité #
|
# * y : increased on minor functionnality additions #
|
||||||
# * z : incrémenté en cas de correctifs (+n correctifs => incrément de +n) #
|
# * z : increased on fixes (+n fixes => increased by +n) #
|
||||||
# #
|
# #
|
||||||
# Tout changement dans le code implique un incrément des numéros de version #
|
##Description of module @template@
|
||||||
# des fichiers concernés (sauf conf) ET un commit dans git. #
|
|
||||||
# #
|
|
||||||
##Description du module @template@
|
|
||||||
##Copyright (c) Year Your Name <your.mail@host.tld>
|
##Copyright (c) Year Your Name <your.mail@host.tld>
|
||||||
##------------------------------------------------------------------------------
|
##------------------------------------------------------------------------------
|
||||||
##This file is distributed under 3-clause BSD license.
|
##<Licence header compatible with BSD-3 licence, you want to use>
|
||||||
##The complete license agreement can be obtained at:
|
|
||||||
##https://opensource.org/licenses/BSD-3-Clause
|
|
||||||
##------------------------------------------------------------------------------
|
##------------------------------------------------------------------------------
|
||||||
##Variable list:
|
##Variable list:
|
||||||
|
## * <VARNAME>: role explaination
|
||||||
##------------------------------------------------------------------------------
|
##------------------------------------------------------------------------------
|
||||||
|
|
||||||
# Version du module
|
##Module version
|
||||||
export VER_@template@="0.0.1"
|
export VER_@template@="0.0.1"
|
||||||
|
|
||||||
# Code du module
|
##Module's code
|
||||||
@template@()
|
@template@()
|
||||||
{
|
{
|
||||||
# Code
|
# Code
|
||||||
}
|
}
|
||||||
|
|
||||||
# Code des vérifications préliminaires
|
##Preliminary checks code for the module
|
||||||
precheck_@template@()
|
precheck_@template@()
|
||||||
{
|
{
|
||||||
# Code
|
# Code
|
||||||
}
|
}
|
||||||
|
|
||||||
# Les fonctions publiques doivent être exportés
|
##Public functions might be exported
|
||||||
export -f @template@
|
export -f @template@
|
||||||
export -f precheck_@template@
|
export -f precheck_@template@
|
||||||
|
|||||||
Reference in New Issue
Block a user