Documentar Software

Documentar Software es, sin duda, un dolor de cabeza. Por eso me he dado a la tarea de escribir un programa que permita documentar programas de una manera que, al menos yo, encuentro atractiva.

¿Y cómo es eso? Bien, ofrece DOS documentaciones. Una en un archivo aparte... standalone. La otra es la suma del archivo aparte con el archivo del código fuente. Ofrecerá capacidad para documentar línea por línea, así que podemos tener una documentación con largas explicaciones que no interrumpen la lectura del código~ prinero lees un módulo, luego lees la documentación línea por línea del módulo. Esto permite explicaciones detalladas y sin miramientos de que cuantas líneas se toma o que hay que poner tal símbolo al inicio de la línea.

El archivo independiente se guarda en el formato "dyc" que me estoy inventando. El significado de dyc es "Documentación Y Comentarios"
La incorporación al archivo de código fuente se hace de manera automática, mediante un archivo "dyp". El significado de dyf es "Documentación y Fuente".

Bien, pues he decidido hacerlo en python. Casi no he programado en el lenguaje, por no decir que no he hecho nada valioso en él... pero he decidido que sé python, así que lo estoy haciendo en python. Hoy he logrado leer el archivo de código fuente y crear un nuevo archivo que tiene el armazón básico del formato dyc.
Nada mal para no saber python, eh?

Publico código fuente y todo lo demás luego... por supuesto, la herramienta será GNU GPL.

¡Se Busca: Colaborador!

La persona que se busca, como está en el anuncio presente en la página, es una persona que cumpla con los siguientes requisitos:

1. Trabaje con tecnología
2. Esté dispuesta a escribir artículos relacionados con su trabajo o sus proyectos.

¿Cómo unirse?

1. Escriba un artículo sobre el trabajo que hace/el proyecto en que trabaja en el que explique qué hace, cómo se hace.
2. Revísele la ortografía.
3. Envíemelo por correo como adjunto, ya sea en formato .doc, .pdf, .rtf, .txt, .odt, et cétera... en realidad puedo leer cualquier formato libre y muchos de los propietarios.
4. En el tema del mensaje, ponga "Soy un Mochador que quiere unirse"

¿Quiere participar sin compromiso?

1. Siga los mismos pasos que en el anterior, pero el mensaje debe ser "Soy un Mochador que quiere compartir"

El correo electrónico es:
axel.rivas {arroba} gmail {punto} com

¿Por qué existe el "Blog del Mochador"?

Hay personas que le enseñan cosas a uno sin apenas formar parte de su vida. Don Antonio Perpiñán es una de las que me ha enseñado de las cosas más importantes y que más concuerdan con mi forma de pensar: Hay que compartir información.
El software libre no es meramente una cuestión de código y dinero: es una cuestión social.
Es un hábito del mencionado señor el leer una cantidad enorme de información y, siguiendo los principios del Código Libre, aportar mejoras a lo que ha aprendido, publicando una vez más sus conocimientos nuevos.

Reconocimientos le faltan a Perpiñán, aunque se los haya ganado. Ha escrito varios libros que recopilan una enorme cantidad de información relacionada con Software Libre de manera tal que una persona puede aprender a utilizar a nivel profesional Sistemas Operativos GNU/Linux en la comodidad de su hogar. ¿Cuántos dominicanos han hecho eso? Más aún: Los vende prácticamente al costo, para poder mantener la FCLD, fundación que creó hacia 1996 y que, también, se dedica a educar sobre el software libre a una tasa impresionantemente baja.
Vaya, eso sí es altruismo. Por eso, aquí su debido homenaje.

Bien, siguiendo el patrón de don Perpiñán, me he dedicado a aprender a aplicar una serie de cosas (como puede observarse con el cvs) y a escribir manuales, instrucciones de como hacerlo. Todo está atado a la FDL versión 1.2.
La meta de este sitio es mantener el hábito de cultivar el conocimiento, crear un repositorio de conocimiento disponible para otros en español (para variar, en este mundo tan en Inglés llamado ciberespacio). Al igual que los libros de Perpiñán, mis textos están distribuidos en la red libre de cargo (vía este sitio).

La línea de fondo: Cultivarme, y permitir que otros se cultiven con mayor facilidad.

Un tema que quizás esté rondando en el fondo de la cabeza de alguien es si aquí habrá información sobre software propietario. La respuesta es sí. Casi puedo oir a los GNUseros quejándose por esto.

Bien, esgrimo un simple argumento: Por cada manual de software propietario o relacionado con él, habrá al menos uno de software libre tratando el mismo tema, y que tenga la misma etiqueta. De esta manera se provee a las personas con una herramienta sumamente útil: la de decidir sabiendo de donde vienen y adónde van, y tener plena conciencia de ello.
¿Qué mejor manera de descubrir cuál es la mejor herramienta que teniendo lado a lado un manual de cada una, con sus características e instrucciones de instalación y/o uso? Porque, hay que admitirlo, hay software propietario útil, y hay software libre realmente torpe.

La diferencia, como dicen los amigos de la FCLD, es que el usuario de Software Libre tiende a ser más culto que los que utilizan software propietario. Pues bien, proveyendo la cultura necesaria de ambos mundos lograremos que se use, no necesariamente lo que queremos, sino lo mejor.

Personalmente quiero afirmar que las herramientas libres tienden a ser mejores, porque los usuarios de Software Libre no dudan en llamear (flame) sobre software inútil o torpe. Más aún, no dudan en mejorarlo y convertirlo en útil si vale la pena evitar desecharlo.

Este blog pretende, de una manera imparcial, dejar que cada quien elija lo que le convenga.
La libertad de elegir conscientemente es, según mi punto de vista, la idea candidata a ser la Quinta Libertad del Software Libre; una libertad implícita creada por el nivel de conocimiento promedio que tienen los usuarios de software libre, que es mucho mayor que el del usuario promedio de software propietario. Nota: dije USUARIO. No tiene que ser Administrador, no tiene que ser NADA. Sólo entrar en la comunidad de Software Libre (Información Libre, en realidad) implica aprender más, por la misma naturaleza de la comunidad.

Espero que descubran qué les conviene. Por mi parte, para las cosas más sencillas de la vida (trabajos de la universidad, presentaciones con diapositivas, hojas de cálculo, escuchar música, chatear) y las más complicadas (Programar, incluso para Windows; Servidor Web; Servidor CVS; Manejo de seguridad; Acceso remoto!), he encontrado más conveniente el barato, ampliamente documentado y sumamente variado mundo del Software Libre, donde hay más justicia y las cosas se comparten porque es legal compartir.

Este blog... quizás les ayude a comprender por qué veo las cosas así.

-Nivreial.

Noticias:

Tras unos minutos de ardua lectura y un breve instante de meditación, he decidido que el blog debe estar bajo la FDL 1.2 o, a su opción, posterior. Pueden apreciar en el lado derecho de la pantalla la sección que habla de eso.

\m/ viva el Ñu!!!

Instalar Servidor CVS en Ubuntu ~ Version 0.9

Al final de pasar lucha por un tiempo con mi sistema y el Internet, he logrado compilar un método comprensivo para instalar y configurar un servidor cvs y repositorio.

Instalando cvs y servidor cvs

#apt-get install cvs
#apt-get install cvsd
##El segundo les llevará a un instalador; les dice que especifiquen repositorios. Estos deben ser separados por ":"; por ejemplo: "/cvsrep:/nivreial" crea dos repositorios: cvsrep y nivreial.

Configurando cvsd
#cd /var/lib/cvsd
#cvsd-buildroot /var/lib/cvsd
##Esto configura /var/lib/cvsd como la raíz de los reposirorios cvs. Hay que hacerlo tras cada actualización del cvsd.

Creando un repositorio cvs

##Los repositorios estarán bajo el directorio /var/lib/cvsd. Ejemplo: /var/lib/cvsd/nivreial
##Crear el contenedor del repositorio en el sitio adecuado
#mkdir /var/lib/cvsd/nivreial
##Dar permiso a cvsd sobre el contenedor del repositorio
#chown -R cvsd:cvsd nivreial
##Inicializar el repositorio
#cvs -d /var/lib/cvsd/nivreial init

Añadiendo Usuarios

#cvsd-passwd /var/lib/cvsd/nivreial +usuariotal
Password:

Repetir tantas veces como sean necesarias para cualquiera de los procesos.

El Arte de Mochar

Las instrucciones sobre como montar un servidor CVS con un servidor pserver tiene mucha inseguridad.

Por tanto, abandoné eso... lo que quedaba era poner usuarios y las contraseñas encriptadas en un archivo passwd en

/usr/local/nivreial/NIVREIAL/

limitar el acceso al archivo con

chmod 400 /usr/local/nivreial/NIVREIAL/passwd


Y luego usarlo.


El arte de mochar a veces acaba, como en este caso, en fracaso.

De manera que desharé los cambios hechos en mi sistema y buscaré otra manera, más segura, de hacer las cosas... porque todo mochador mocha bien, o no mocha.

O mocha mal si se puede y luego hace un upgrade.
Por ahora creo que me queda mejor la segunda, porque es un servidor local y no necesito seguridad.

Creando un Repositorio CVS 2 a

Ahora vamos paso a pasito, ¿como es la cosa de verdad? Todo lo dicho en el post anterior suena bonito pero, ¿cómo se hace?

Bien, he aquí el proceso seguido en mi PC (Parte a) y su explicación.

#NOTA: Previamente había instalado el inetd, con la instrucción
#apt-get install openbsd-inetd

----
irving@irving-desktop:~$su -
Password:
root@irving-desktop:~#apt-get install cvs
root@irving-desktop:~#useradd cvs -G cvs
root@irving-desktop:~#cvs -d /usr/local/nivreial init
root@irving-desktop:~#chown -R cvs.cvs /usr/local/nivreial
root@irving-desktop:~#cat /etc/services | grep cvs
# sources like http://www.freebsd.org/cgi/cvsweb.cgi/src/etc/services .
cvspserver 2401/tcp # CVS client/server operations
cvspserver 2401/udp
root@irving-desktop:~#cat /etc/inetd.conf | grep cvs
root@irving-desktop:~#cat >> /etc/inetd.conf
#
#CVS Pserver
#
cvspserver stream tcp nowait cvs /usr/bin/cvs cvs --allwo-root=/usr/local/nivreial pserver
root@irving-desktop:~##Nota: desde cvspserver en adelante, es una sola línea
root@irving-desktop:~#inetd restart
root@irving-desktop:~#su cvs
$
----

Por numero de instrucción:

1. cambiar a super usuario (Administrador)
2. Instalar software de cvs
3. Añadir usuario y grupo cvs de un tirón, estando el usuario en el grupo.
4. Crear el repositorio nivreial
5. Darle poder al usuario cvs sobre el repositorio
6. Revisar en qué líneas del archivo /etc/services estaba la cadena "cvs". Esto era para saber si tenía que añadir manualmente el serivicio
   
7. Revisar en qué líneas del archivo /etc/inetd.conf estaba la cadena "cvs". No estaba.
8. Añadir el servicio cvs en inetd
9. Explicar algo alusivo al comando 8
10. Reiniciar el servicio inetd (Ubuntu)
11. Cambiar de usuario a cvs

Hasta ahí se queda... luego viene alguillo con perl y otro tanto más que explicar...

Creando un Repositorio CVS 1

Un repositorio CVS es una herramienta muy útil para cualquier programador; he encontrado utilidad también para los escritores, y es en este ámbito que voy a explorar su utilidad... para avanzar en mi proyecto literario, nivreial el cual tiene ciertos aspectos complejos que necesitan de diversos archivos e incluso un sistema de carpetas para ser escrito.

Bien! He encontrado unas instrucciones para montar el servidor CVS:

1. Entrar como Root
2. Instalar cvs
   
3. Crear usuario y grupo cvs
   
4. Crear el repositorio
5. Asignar el repositorio al grupo y usuario cvs
6. Crear servicio tcp
7. crear entrada de inetd
8. Reiniciar inetd
9. Crear contraseñas para los usuarios de cvs

Eso es todo. Comando por comando? Viene en camino... ese es sólo el resumen.