updated docs

git-svn-id: svn+slack://slack.fluxo.info/var/svn/simplepkg@383 04377dda-e619-0410-9926-eae83683ac58

2 files changed, 56 insertions, 52 deletions

diff --git a/trunk/doc/README b/trunk/doc/README
index 8a438bf..ae4c423 100644
--- a/trunk/doc/README
+++ b/trunk/doc/README
@@ -415,8 +415,8 @@ in its own documentation.
 Its important to note that all boolean parameters in the config file can be set either to "1" or "yes"
 to enable and "0" or "no" to disable.
 
-More information
-----------------
+Additional information
+----------------------
 
 Simplepkg was written by Silvio Rhatto (rhatto at riseup.net) and is released under GPL license. The code
 can be obtained from the subversion repository:
diff --git a/trunk/doc/README.simplaret b/trunk/doc/README.simplaret
index c4399bd..397d913 100644
--- a/trunk/doc/README.simplaret
+++ b/trunk/doc/README.simplaret
@@ -221,82 +221,75 @@ The repos.conf file contains one repository definition per line using the follow
 The content in brackets are optional depending on the repository type as we'll see later in this
 section. The repository types supported by simplaret are:
 
-  - PATCHES: definição para repositórios que contenham patches (pacotes de atualização) e cuja lista
-    de arquivos é FILE_LIST e não FILELIST.TXT; exemplo:
+  - PATCHES: used for repositories containing patches and which file metadata is the file
+    FILE_LIST instead the standard FILELIST.TXT; example:
 
       PATCHES-i386-11.0="sarava%http://slack.sarava.org/packages/slackware/slackware-11.0/patches/"
 
-    No caso da definição acima, temos um repositório de patches para a arquitetura i386 (distribuição
-    Slackware), versão 11.0 e o nome dado ao repositório é "sarava".
+    This defines a patches repository for arch i386 (official Slackware), version 11.0 and named
+    as "sarava".
 
-    Possuir uma definição do tipo PATCHES é opcional para ter acesso às atualizações: a definição
-    de repositório ROOT, que veremos em seguida, já lida com patches: o tipo de repositório PATCHES
-    serve apenas se você quiser utilizar algum repositório não-oficial como fonte de patches
-    prioritária, já que repositório PATCHES são pesquisados pelo simplaret antes de qualquer outro.
+    Its optional to have a PATCHES definition in order to get patches: the ROOT repository definition
+    just take care of that and you'll just need to use a PATCHES definition if you want to give
+    precedence to some patches repository over all other definition types.
 
-    Em resumo, se você não tiver um bom motivo para usar esse tipo de repositório, evite-o.
-
-  - ROOT: são tipos de repositórios cujo conteúdo está dividido por versão. O exemplo tradicional
-    deste caso é o próprio repositório oficial das distribuições:
+  - ROOT: this type specifies the default slackware-like repository, where the content is sorted
+    by version. An official slackware repository then is defined as
 
       ROOT-i386="tds%http://slackware.mirrors.tds.net/pub/slackware/"
 
-    Repositórios ROOT necessitam apenas de uma definição de arquitetura, um nome e uma URL. No caso
-    acima, temos a definição de repositório ROOT de nome "tds", ou seja, não há definição de versão,
-    já que o simplaret considerará que a versão desejada está numa subpasta dessa URL. Ou seja,
-    definições ROOT implicam que as pastas contendo pacotes de cada versão estejam bem separadas,
-    ou seja, pastas como http://slackware.mirrors.tds.net/pub/slackware/slackware-10.2/ e
-    http://slackware.mirrors.tds.net/pub/slackware/slackware-11.0/.
+    ROOT repositories needs just the arch definition, a name and an URL. In the previous case,
+    we have a ROOT repository called "tds". It doesn't need any version information as its already
+    considers tha the content is sorted in folders like
+
+      http://slackware.mirrors.tds.net/pub/slackware/slackware-10.2/ and
+      http://slackware.mirrors.tds.net/pub/slackware/slackware-11.0/
 
-  - REPOS: este tipo de repositório é orientado a arquitetura e versão, como por exemplo
+  - REPOS: this repository type ir arch and version oriented, like
 
       REPOS-i386-11.0="sarava%http://slack.sarava.org/packages/slackware/slackware-11.0/"
 
-    No caso acima, um repositório de nome "sarava" é definido para a arquitetura i386 e versão
-    11.0 com a URL http://slack.sarava.org/packages/slackware/slackware-11.0/. Esse tipo de definição
-    é recomendado para repositórios não-oficiais.
+    In the above case, a repository called "sarava" is defined using arch i386 and version 11.0
+    with URL http://slack.sarava.org/packages/slackware/slackware-11.0/. This repository type is
+    recommended when using non-official repositories.
 
-  - NOARCH: o último tipo de definição é usado para repositórios cujos pacotes são independentes
-    de arquitetura e versão da distribuição. Como exemplo temos um repositório do Projeto Slack:
+  - NOARCH: the last type is used to define repositories where packages are arch and version
+    independent, like
 
       NOARCH="sarava%http://slack.sarava.org/packages/noarch"
 
-Em qualquer tipo de repositório, a URL pode ser do tipo http://, ftp:// ou file:// (para repositórios
-locais).
+In any repository type, the supperted URL schemes are http://, ftp:// or file:// (for local
+repositories).
 
-Como podem haver mais de uma definição de repositório para cada tipo, versão e/ou arquitetura,
-as mesmas são diferenciadas de acordo com o nome. Definições de repositório podem ter nomes idênticos,
-desde que se refiram a tipo de repositório e/ou arquitetura e versão diferentes.
+As simplaret supports more than one repository definition for each type, arch or version, each
+definition has its own name. Definitions can have the same name just if they're dont use the
+same repository type and/or arch and version.
 
-Existe ainda uma prioridade dentre tipos de repositório e ordens de precedência. Numa pesquisa,
-repositórios são pesquisados de acordo com a seguinte ordem:
+There's also a priority rule between the repository types wich defines a precedence order.
+Repositories are searched according the following order:
 
-  - PATCHES tem prioridade mais alta: caso um pacote de uma dada arquitetura e versão não seja
-    encontrado no primeiro repositório PATCHES do repos.conf, o próximo repositório definido na
-    ordem em que ele aparece no arquivo é pesquisado, e assim por diante.
+  - PATCHES has the highest priority: if a package from a given arch and version is not found
+    in the first (if existent) PATCHES definition, then the next one is searched until all
+    PATCHES definitions are searched.
 
-  - Em seguida, pacotes são procurados nas definições ROOT da arquitetura em questão, na ordem
-    em que aparecem no repos.conf.
+  - Then, the package is searched in all ROOT defintions in the order they appear at repos.conf.
 
-  - Depois, são os pacotes de repositórios REPOS daquela arquitetura e versão são pesquisados,
-    na ordem em que aparecem no repos.conf.
+  - The next searched repository type is REPOS in the specified arch an version, in the order
+    they appear at repos.conf.
 
-  - Por fim, repositórios NOARCH são pesquisados, na ordem em que são definidos.
+  - At last, NOARCH type is searched in the order they're defined.
 
-Em resumo, o simplaret tem uma ordem de precedência e execução de repositórios e para busca e obtenção
-de pacotes: pacotes são exibidos de acordo com a ordem e precedência descritas acima. No caso da ontenção
-de pacotes, o primeiro repositório que possuí-lo será utilizado, isto é, caso o pacote não for solicitado
-explicitamente com seu nome de arquivo completo mas sim apenas com seu nome.
+In the case you're issuing an upgrade or just geting patches, simplaret by default will just
+search in PATCHES and ROOT definitions.
 
-No caso da obtenção de patches, por padrão apenas repositórios do tipo PATCHES e ROOT são pesquisados,
-a não ser que isso seja configurado como contrário.
+At REPOS and ROOT is also possible to specify its internal search order according its subfolders.
 
-Em repositórios do tipo REPOS e ROOT ainda é possível, através de parâmetros de configuração, explicitar
-a ordem de pastas que são pesquisadas dentro dos repositórios, algo que veremos a seguir e facilita no
-caso do usuário estar interessado em dar prioridade para aplicativos em fase de testes (usualmente
-armazenados na pasta testing/) ou pacotes antigos (pasture).
+Configuration file simplepkg.conf
+---------------------------------
 
-[...]
+Simplaret also stores its configurations inside simplepkg's configuration file
+/etc/simplepkg/simplepkg.conf. This file is well commented and you should find there a description
+of all supported options.
 
 But why use that?
 -----------------
@@ -313,3 +306,14 @@ and versions are installed. Suppose a x86_64 with the following chroots installe
 
 Keep all this stuff update manually is really a headache. Simplaret just tries to make it trivial.
 
+Additional information
+----------------------
+
+Simplaret was written by Silvio Rhatto (rhatto at riseup.net) and is released under GPL license. The code
+can be obtained from the subversion repository:
+
+  svn checkout svn://slack.sarava.org/simplepkg
+
+Simplepkg's wiki is http://slack.sarava.org/wiki/Main/SimplePKG and its mailing list address is
+http://listas.sarava.org/wws/info/slack.
+