YunoHost/yunohost
1
0
Fork 0
mirror of https://github.com/YunoHost/yunohost.git synced 2024-09-03 20:06:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

helpers/doc: De-hide some helpers v1 in documentation now that the structure is less bloated sort of ?

Browse source
This commit is contained in:
Alexandre Aubin 2024-06-25 00:21:24 +02:00
parent 7347b08e49
commit 2a7fefaecb
3 changed files with 0 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
helpers/helpers.v1.d/apt
View file

@ -224,8 +224,6 @@ YNH_INSTALL_APP_DEPENDENCIES_REPLACE="true"
# Define and install dependencies with a equivs control file # Define and install dependencies with a equivs control file
# #
# [packagingv1]
#
# This helper can/should only be called once per app # This helper can/should only be called once per app
# #
# example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5" # example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
@ -364,8 +362,6 @@ ynh_add_app_dependencies() {
# Remove fake package and its dependencies # Remove fake package and its dependencies
# #
# [packagingv1]
#
# Dependencies will removed only if no other package need them. # Dependencies will removed only if no other package need them.
# #
# usage: ynh_remove_app_dependencies # usage: ynh_remove_app_dependencies
@ -398,8 +394,6 @@ ynh_remove_app_dependencies() {
# Install packages from an extra repository properly. # Install packages from an extra repository properly.
# #
# [packagingv1]
#
# usage: ynh_install_extra_app_dependencies --repo="repo" --package="dep1 dep2" [--key=key_url] [--name=name] # usage: ynh_install_extra_app_dependencies --repo="repo" --package="dep1 dep2" [--key=key_url] [--name=name]
# | arg: -r, --repo= - Complete url of the extra repository. # | arg: -r, --repo= - Complete url of the extra repository.
# | arg: -p, --package= - The packages to install from this extra repository # | arg: -p, --package= - The packages to install from this extra repository

14
helpers/helpers.v1.d/permission
View file

@ -36,8 +36,6 @@
# | arg: -t, --show_tile= - (optional) Define if a tile will be shown in the SSO. If yes the name of the tile will be the 'label' parameter. Defaults to false for the permission different than 'main'. # | arg: -t, --show_tile= - (optional) Define if a tile will be shown in the SSO. If yes the name of the tile will be the 'label' parameter. Defaults to false for the permission different than 'main'.
# | arg: -P, --protected= - (optional) Define if this permission is protected. If it is protected the administrator won't be able to add or remove the visitors group of this permission. Defaults to 'false'. # | arg: -P, --protected= - (optional) Define if this permission is protected. If it is protected the administrator won't be able to add or remove the visitors group of this permission. Defaults to 'false'.
# #
# [packagingv1]
#
# If provided, 'url' or 'additional_urls' is assumed to be relative to the app domain/path if they # If provided, 'url' or 'additional_urls' is assumed to be relative to the app domain/path if they
# start with '/'. For example: # start with '/'. For example:
# / -> domain.tld/app # / -> domain.tld/app
@ -145,8 +143,6 @@ ynh_permission_create() {
# Remove a permission for the app (note that when the app is removed all permission is automatically removed) # Remove a permission for the app (note that when the app is removed all permission is automatically removed)
# #
# [packagingv1]
#
# example: ynh_permission_delete --permission=editors # example: ynh_permission_delete --permission=editors
# #
# usage: ynh_permission_delete --permission="permission" # usage: ynh_permission_delete --permission="permission"
@ -165,8 +161,6 @@ ynh_permission_delete() {
# Check if a permission exists # Check if a permission exists
# #
# [packagingv1]
#
# usage: ynh_permission_exists --permission=permission # usage: ynh_permission_exists --permission=permission
# | arg: -p, --permission= - the permission to check # | arg: -p, --permission= - the permission to check
# | exit: Return 1 if the permission doesn't exist, 0 otherwise # | exit: Return 1 if the permission doesn't exist, 0 otherwise
@ -185,8 +179,6 @@ ynh_permission_exists() {
# Redefine the url associated to a permission # Redefine the url associated to a permission
# #
# [packagingv1]
#
# usage: ynh_permission_url --permission "permission" [--url="url"] [--add_url="new-url" [ "other-new-url" ]] [--remove_url="old-url" [ "other-old-url" ]] # usage: ynh_permission_url --permission "permission" [--url="url"] [--add_url="new-url" [ "other-new-url" ]] [--remove_url="old-url" [ "other-old-url" ]]
# [--auth_header=true|false] [--clear_urls] # [--auth_header=true|false] [--clear_urls]
# | arg: -p, --permission= - the name for the permission (by default a permission named "main" is removed automatically when the app is removed) # | arg: -p, --permission= - the name for the permission (by default a permission named "main" is removed automatically when the app is removed)
@ -255,8 +247,6 @@ ynh_permission_url() {
# Update a permission for the app # Update a permission for the app
# #
# [packagingv1]
#
# usage: ynh_permission_update --permission "permission" [--add="group" ["group" ...]] [--remove="group" ["group" ...]] # usage: ynh_permission_update --permission "permission" [--add="group" ["group" ...]] [--remove="group" ["group" ...]]
# [--label="label"] [--show_tile=true|false] [--protected=true|false] # [--label="label"] [--show_tile=true|false] [--protected=true|false]
# | arg: -p, --permission= - the name for the permission (by default a permission named "main" already exist) # | arg: -p, --permission= - the name for the permission (by default a permission named "main" already exist)
@ -362,8 +352,6 @@ ynh_permission_has_user() {
# Check if a legacy permissions exist # Check if a legacy permissions exist
# #
# [packagingv1]
#
# usage: ynh_legacy_permissions_exists # usage: ynh_legacy_permissions_exists
# | exit: Return 1 if the permission doesn't exist, 0 otherwise # | exit: Return 1 if the permission doesn't exist, 0 otherwise
# #
@ -379,8 +367,6 @@ ynh_legacy_permissions_exists() {
# Remove all legacy permissions # Remove all legacy permissions
# #
# [packagingv1]
#
# usage: ynh_legacy_permissions_delete_all # usage: ynh_legacy_permissions_delete_all
# #
# example: # example:

4
helpers/helpers.v1.d/systemuser
View file

@ -42,8 +42,6 @@ ynh_system_group_exists() {
# Create a system user # Create a system user
# #
# [packagingv1]
#
# usage: ynh_system_user_create --username=user_name [--home_dir=home_dir] [--use_shell] [--groups="group1 group2"] # usage: ynh_system_user_create --username=user_name [--home_dir=home_dir] [--use_shell] [--groups="group1 group2"]
# | arg: -u, --username= - Name of the system user that will be create # | arg: -u, --username= - Name of the system user that will be create
# | arg: -h, --home_dir= - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home # | arg: -h, --home_dir= - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home
@ -98,8 +96,6 @@ ynh_system_user_create() {
# Delete a system user # Delete a system user
# #
# [packagingv1]
#
# usage: ynh_system_user_delete --username=user_name # usage: ynh_system_user_delete --username=user_name
# | arg: -u, --username= - Name of the system user that will be create # | arg: -u, --username= - Name of the system user that will be create
# #