aboutsummaryrefslogtreecommitdiff
path: root/GUIDELINES
diff options
context:
space:
mode:
Diffstat (limited to 'GUIDELINES')
-rwxr-xr-xGUIDELINES105
1 files changed, 105 insertions, 0 deletions
diff --git a/GUIDELINES b/GUIDELINES
new file mode 100755
index 0000000..8028132
--- /dev/null
+++ b/GUIDELINES
@@ -0,0 +1,105 @@
+Pequena politica de desenvolvimento pro firma
+---------------------------------------------
+
+Intuito: ajudar no controle do desenvolvimento para
+ que o codigo nao estufe de lixo e que se mantenha seguro.
+
+Apos qualquer adicao no firma, efetue o seguinte procedimento
+-------------------------------------------------------------
+
+ - Coloque as novas variaveis criadas na lista de variaveis
+ - Coloque as novas funcoes criadas na lista de funcoes
+ - Coloque os novos arrays na variavei USED_ARRAYS
+ - Se estiver usando um comando unix, verifique se o mesmo jah estah listado
+ na lista de programas, caso contrario adicione-o
+
+Uso de variaveis
+----------------
+
+ - Variaves globais: uppercase
+ - Variaves locais a uma funcao ou rotina: lowercase, devem ser zeradas depois do uso
+ - Cuidado com a inicializacao, zerar tudo quando nao mais necessario
+
+Listagem
+--------
+
+- funcoes utilizadas:
+
+ usage
+ version
+ check_config
+ get_gpg_stderr
+ get_subscribers_list
+ get_message
+ get_gpg_message
+ get_message_headers
+ message_list
+ message_list_error
+ message_list_return
+ process_message
+ newlist
+ gpg_args
+ list_admin
+ choose_uid
+
+- variaveis utilizadas:
+
+ - via arquivo de configuracao
+
+ MAIL
+ MAIL_ARGS
+ GPG
+ LISTNAME
+ LISTADMIN
+ GPGDIR
+ PASSWD
+
+ - direto no script
+
+ FIRMA_LIST_PATH
+ VERSION
+ LINES
+ FROM
+ FROMADD
+ DATE
+ SUBJECT
+ EMAIl (mudar para lowercase?)
+
+ CONFIG
+ CONFIG_PATH
+ CONFIG_FILE
+
+ DESCRIPTION
+
+ GPGFLAGS
+ GPGCOMMAND
+ GPGLIST
+ GPGDECRYPT
+ GPGENCRYPT
+
+ KEYID
+
+ - variaveis auxiliares: x, n, signal
+
+ - arrays
+
+ ver USED_ARRAYS
+ ADMINCOMMANDS
+
+- Comandos Unix:
+
+ $MAIL
+ $GPG
+
+ echo
+ cat
+ grep
+ wc
+ tr
+ cut
+ sed
+ mkdir
+ touch
+ chmod
+ basename
+ expect