| Documentação Firebird → Para escritores de documentação Firebird → Obter e gerar as manuais → Obtendo o módulo do SF |
|
|
|
O módulo de manuais é parte do repositório CVS no SourceForge. Para baixá-lo, é necessário um tipo de software chamado cliente CVS. Esta seção descreve os passos necessários para obter o software e o módulo de manual. A geração de manuais será discutida na seção Gerando os doc Firebird
CVS significa Sistema de Versões Concorrentes. É uma ferramenta para gerenciamento de software, útil tanto para desenvolvedores como para o trabalho em equipe. Praticamente todos os projetos no SourceForge usam o CVS para armazenar e desenvolver suas bases de código. A árvore do Firebird no CVS é dividida em diversos módulos, o módulo de manuais sendo um desses.
Baixar um módulo de um repositório CVS é chamado de checking out na linguagem do CVS.
do Tradutor: não encontrei uma tradução satisfatória para check out. A expressão será utilizada no original.
Para se fazer isso, é necessário um cliente CVS, os quais existem em praticamente todos sistemas operacionais. Aqui temos uma lista desses clientes para alguns SOs populares:
Linux, BSD e outros *nix
CVS em linha de comando é freqüentemente pré-instalado. Senão, use as ferramentas de administração para instalar isso - você tipicamente achará isso na categoria de desenvolvimento. Se isso não funcionar para você, obtenha-o em http://www.cvshome.org
gCVS - uma interface gráfica para o CVS, em http://cvsgui.sourceforge.net/download.html
Windows
CVS em linha de comando em http://www.cvshome.org
WinCVS: Bastante poderoso, porém bastante complicado para o novato. Baixar em: http://cvsgui.sourceforge.net
TortoiseCVS: plugin para o Windows Explorer. Brilhante, fácil de usar, intuitivo - embora não tenha as funcionalidades avançadas do WinCVS, mas nada básico foi deixado de fora. Baixar em http://tortoisecvs.sourceforge.net/download.shtml
Macintosh OS X (OSX) & Macintosh Classic (Classic)
(OSX) Já vem instalado o CVS em linha de comando
(OSX) Fink (ferramentas Unix para OS X) contém uma versão mais atualizada do CVS. Baixar em http://fink.sourceforge.net/download.html
(Ambos) MacCvsX em http://cvsgui.sourceforge.net/download.html. É do mesmo projeto do gCVS e WinCVS. Esse porte para OS X ainda está em beta.
(Ambos) MacCvs Pro em http://sourceforge.net/projects/maccvspro/
Outras plataformas
Tente sua sorte em http://www.cvshome.org
Faça uma busca no Google
Ou então pergunte no newsgroup gnu.cvs.help ou na lista de mensagens firebird-docs
Baixe e instale (pelo menos) um dos clientes de CVS acima mencionados e instale de acordo com as instruções que vêm com o mesmo. Depois disso, você está pronto para fazer check out do módulo de manuais.
Existem duas maneiras de fazer check out do módulo de manuais: como usuário anônimo ou com seu apelido no SourceForge. O segundo método é chamado geralmente de SSH check out (porque usa uma Interface Segura) ou então EXT check out (por causa de usar o SSH como protocolo EXTerno).
Todos podem fazer o check out anonimamente. Membros do projeto Firebird também podem fazer check out com o seu apelido do SourceForge.
Mesmo que você tenha a conta no SourceForge, é necessário a sua inclusão como membro do projeto Firebird; caso contrário, só poderá fazer check out anonimamente.
Se você for um membro do projeto, certamente irá preferir fazer check out com seu apelido no SourceForge porque
Um check out anônimo não está sempre atualizado (o atraso pode variar de várias horas ou mesmo dias)
Se você irá contribuir para o módulo de manuais, você TEM fazer o check out com seu apelido do SourceFore ou não será capaz de finalizar (atualizar) suas mudanças para o repositório remoto.
Nós descreveremos ambos os métodos nas subseções seguintes. Clique aqui para ir direto à subseção sobre SSH check outs.
O processo de fazer check outs depende de qual cliente você usa. Nós daremos a você instruções exatas para o CVS em linha de comando. E com relação aos outros clientes, daremos as informações genéricas que você precisa para usá-lo.
Se você está em ambiente gráfico, abra uma janela de linha de comando (no Windows é chamada de Prompt de comando)
Primeiro, você precisa verficar a senha com o sevidor e armazená-la localmente. Dispare o comando:
cvs -d:pserver:[email protected]:/cvsroot/firebird login
Quando for perguntado por uma senha, apenas aperte Enter, porque a senha para o usuário anônimo é vazia. Seu cliente CVS vai armazenar a senha para uso posterior, de modo que você poderá pular este passo no futuro, a não ser que você se autentique com outras senhas antes disso.
Agora você poderá baixar o módulo de manuais. Dispare o comando:
cvs -z6 -d:pserver:[email protected]:/cvsroot/firebird checkout manual
Se tudo der certo, uma pasta chamada manual será criada abaixo da pasta corrente, e a árvore de pastas dos fontes será baixada para ela. Agora você pode gerar os documentos – leia mais em Gerando os documentos do Firebird
Existe muita variação para dar informação exata para todos os clientes CVS aqui. Consulte a documentação (ou a ajuda online) para o seu cliente. Os elementos que você precisará saber (e preencher) em algum ponto são:
deve ser ajustado para pserver (servidor de senhas)
o mesmo acima
cvs.sourceforge.net
/cvsroot/firebird
anonymous
manual
geralmente uma do servidor com o repositório, algumas vezes até iniciando com o nome do usuário (e.g. WinCVS): cvs.sourceforge.net:/cvsroot/firebird ou [email protected]:/cvsroot/firebird
Preencha os dados necessários e dispare o comando check out no seu cliente. Se o processo for bem sucedido, agora você tem uma cópia local do módulo de manuais no seu computador e está pronto para gerar os documentos. Leia mais em Gerando os documentos do Firebird
Para ser capaz de realizar um SSH check out , uma interface cliente segura deve estar presente no seu sistema. Na maioria dos sistemas Unix, assim como no Mac OS X, OpenSSH é instalado por padrão. Se não, verifique o CD da distribuição ou obtenha o mesmo de http://www.openssh.com. Esse site também contém outros produtos para sistemas operacionais não suportados pelo OpenSSH. No entanto, perceba que instalar o OpenSSH em algumas plataformas (incluindo aí o Windows) não é uma tarefa trivial. Para facilitar a sua vida, escolha um cliente CVS que já possua suporte SSH embutido (exemplo: Tortoise CVS para Windows).
Assim como no caso dos check outs anônimos, o procedimento do cliente que você utiliza. E, novamente, daremos instruções exatas para o CVS em linha de comando e informações genéricas para outros clientes.
Estando em ambiente gráfico, abra uma janela de linha de comando
Tenha certeza que a variável de ambiente chamada CVS_RSH com o valor "ssh" (ou qualquer que seja o nome do seu cliente SSH). Como proceder depende do seu SO. Na linha de comando do Windows/DOS, use set CVS_RSH=ssh. Com o Linux/bash: export CVS_RSH=ssh.
Você pode tornar essa variável de ambiente permanente, de modo que este passo não precise ser repetido. Verifique a documentação do seu SO para saber como fazer isso.
Dispare o seguinte comando para obter o módulo de manuais (troque "username" pelo seu próprio apelido no SourceForge):
cvs -z6 -d:ext:[email protected]:/cvsroot/firebird checkout manual
Entre a sua senha quando perguntado pela mesma.
Se tudo der certo, uma pasta chamada manual será criada abaixo da pasta corrente, e a árvore de pastas dos fontes será baixada para ela. Agora você pode gerar os documentos - leia mais em Gerando os documentos do Firebird.
Existe muita variação para dar informação exata para todos os clientes CVS aqui. Consulte a documentação (ou a ajuda online) para o seu cliente. Os elementos que você precisará saber (e preencher) em algum ponto são:
deve ser ajustado para ext (ou SSH, ou SSL)
o mesmo acima
cvs.sourceforge.net
/cvsroot/firebird
seu apelido no SourceForge
manual
geralmente uma do servidor com o repositório, algumas vezes até iniciando com o nome do usuário (e.g. WinCVS): cvs.sourceforge.net:/cvsroot/firebird ou [email protected]:/cvsroot/firebird
Preencha os dados necessários e dispare o comando check out no seu cliente. Se o processo for bem sucedido, agora você tem uma cópia local do módulo de manuais no seu computador e está pronto para gerar os documentos.
Você pode ainda enviar as alterações feitas localmente de volta para o repositório.
|
| Documentação Firebird → Para escritores de documentação Firebird → Obter e gerar as manuais → Obtendo o módulo do SF |