mirror of
https://github.com/YunoHost/yunohost.git
synced 2024-09-03 20:06:10 +02:00
Add some [internal] flags in the comment to hide a few helpers from autodoc
This commit is contained in:
parent
935b972d6e
commit
af22474a50
5 changed files with 27 additions and 1 deletions
|
@ -136,6 +136,8 @@ ynh_restore () {
|
||||||
|
|
||||||
# Return the path in the archive where has been stocked the origin path
|
# Return the path in the archive where has been stocked the origin path
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# usage: _get_archive_path ORIGIN_PATH
|
# usage: _get_archive_path ORIGIN_PATH
|
||||||
_get_archive_path () {
|
_get_archive_path () {
|
||||||
# For security reasons we use csv python library to read the CSV
|
# For security reasons we use csv python library to read the CSV
|
||||||
|
@ -203,6 +205,9 @@ ynh_restore_file () {
|
||||||
}
|
}
|
||||||
|
|
||||||
# Deprecated helper since it's a dangerous one!
|
# Deprecated helper since it's a dangerous one!
|
||||||
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
ynh_bind_or_cp() {
|
ynh_bind_or_cp() {
|
||||||
local AS_ROOT=${3:-0}
|
local AS_ROOT=${3:-0}
|
||||||
local NO_ROOT=0
|
local NO_ROOT=0
|
||||||
|
@ -213,6 +218,8 @@ ynh_bind_or_cp() {
|
||||||
|
|
||||||
# Create a directory under /tmp
|
# Create a directory under /tmp
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# Deprecated helper
|
# Deprecated helper
|
||||||
#
|
#
|
||||||
# usage: ynh_mkdir_tmp
|
# usage: ynh_mkdir_tmp
|
||||||
|
|
|
@ -35,6 +35,8 @@ ynh_mysql_execute_file_as_root() {
|
||||||
|
|
||||||
# Create a database and grant optionnaly privilegies to a user
|
# Create a database and grant optionnaly privilegies to a user
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# usage: ynh_mysql_create_db db [user [pwd]]
|
# usage: ynh_mysql_create_db db [user [pwd]]
|
||||||
# | arg: db - the database name to create
|
# | arg: db - the database name to create
|
||||||
# | arg: user - the user to grant privilegies
|
# | arg: user - the user to grant privilegies
|
||||||
|
@ -56,6 +58,8 @@ ynh_mysql_create_db() {
|
||||||
|
|
||||||
# Drop a database
|
# Drop a database
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# If you intend to drop the database *and* the associated user,
|
# If you intend to drop the database *and* the associated user,
|
||||||
# consider using ynh_mysql_remove_db instead.
|
# consider using ynh_mysql_remove_db instead.
|
||||||
#
|
#
|
||||||
|
@ -78,6 +82,8 @@ ynh_mysql_dump_db() {
|
||||||
|
|
||||||
# Create a user
|
# Create a user
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# usage: ynh_mysql_create_user user pwd [host]
|
# usage: ynh_mysql_create_user user pwd [host]
|
||||||
# | arg: user - the user name to create
|
# | arg: user - the user name to create
|
||||||
# | arg: pwd - the password to identify user by
|
# | arg: pwd - the password to identify user by
|
||||||
|
@ -103,6 +109,8 @@ ynh_mysql_user_exists()
|
||||||
|
|
||||||
# Drop a user
|
# Drop a user
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# usage: ynh_mysql_drop_user user
|
# usage: ynh_mysql_drop_user user
|
||||||
# | arg: user - the user name to drop
|
# | arg: user - the user name to drop
|
||||||
ynh_mysql_drop_user() {
|
ynh_mysql_drop_user() {
|
||||||
|
|
|
@ -26,6 +26,8 @@ ynh_package_version() {
|
||||||
|
|
||||||
# APT wrapper for non-interactive operation
|
# APT wrapper for non-interactive operation
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# usage: ynh_apt update
|
# usage: ynh_apt update
|
||||||
ynh_apt() {
|
ynh_apt() {
|
||||||
DEBIAN_FRONTEND=noninteractive sudo apt-get -y -qq $@
|
DEBIAN_FRONTEND=noninteractive sudo apt-get -y -qq $@
|
||||||
|
@ -73,6 +75,8 @@ ynh_package_autopurge() {
|
||||||
|
|
||||||
# Build and install a package from an equivs control file
|
# Build and install a package from an equivs control file
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# example: generate an empty control file with `equivs-control`, adjust its
|
# example: generate an empty control file with `equivs-control`, adjust its
|
||||||
# content and use helper to build and install the package:
|
# content and use helper to build and install the package:
|
||||||
# ynh_package_install_from_equivs /path/to/controlfile
|
# ynh_package_install_from_equivs /path/to/controlfile
|
||||||
|
|
|
@ -6,7 +6,11 @@ ynh_die() {
|
||||||
}
|
}
|
||||||
|
|
||||||
# Ignore the yunohost-cli log to prevent errors with conditionals commands
|
# Ignore the yunohost-cli log to prevent errors with conditionals commands
|
||||||
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# usage: ynh_no_log COMMAND
|
# usage: ynh_no_log COMMAND
|
||||||
|
#
|
||||||
# Simply duplicate the log, execute the yunohost command and replace the log without the result of this command
|
# Simply duplicate the log, execute the yunohost command and replace the log without the result of this command
|
||||||
# It's a very badly hack...
|
# It's a very badly hack...
|
||||||
ynh_no_log() {
|
ynh_no_log() {
|
||||||
|
|
|
@ -1,5 +1,7 @@
|
||||||
# Manage a fail of the script
|
# Manage a fail of the script
|
||||||
#
|
#
|
||||||
|
# [internal]
|
||||||
|
#
|
||||||
# usage:
|
# usage:
|
||||||
# ynh_exit_properly is used only by the helper ynh_abort_if_errors.
|
# ynh_exit_properly is used only by the helper ynh_abort_if_errors.
|
||||||
# You should not use it directly.
|
# You should not use it directly.
|
||||||
|
@ -36,7 +38,8 @@ ynh_exit_properly () {
|
||||||
#
|
#
|
||||||
# This configure the rest of the script execution such that, if an error occurs
|
# This configure the rest of the script execution such that, if an error occurs
|
||||||
# or if an empty variable is used, the execution of the script stops
|
# or if an empty variable is used, the execution of the script stops
|
||||||
# immediately and a call to `ynh_exit_properly` is triggered.
|
# immediately and a call to `ynh_clean_setup` is triggered if it has been
|
||||||
|
# defined by your script.
|
||||||
#
|
#
|
||||||
ynh_abort_if_errors () {
|
ynh_abort_if_errors () {
|
||||||
set -eu # Exit if a command fail, and if a variable is used unset.
|
set -eu # Exit if a command fail, and if a variable is used unset.
|
||||||
|
|
Loading…
Add table
Reference in a new issue