mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: "Guillermo López Alejos" <glalejos@gmail.com>
To: "Sam Vilain" <sam@vilain.net>
Cc: "Linux Kernel mailing list" <linux-kernel@vger.kernel.org>
Subject: Re: Introducting LXD
Date: Wed, 22 Mar 2006 11:45:43 +0100	[thread overview]
Message-ID: <4fec73ca0603220245y72e66279jeaf93a944334a879@mail.gmail.com> (raw)
In-Reply-To: <44208914.9020604@vilain.net>

> Yes, I could follow the link, but there was nothing really there in your
> post to make me want to bite.

O.K., I'll try to show some of the interesting aspects of LXD.

LXD intends to be a documentation system for large open source
projects. Its main objective is to gather high level information that
cannot be extracted from the source files.

The main strengths of LXD are:
    * Documentation is separated from source files:
        - High level information usually does not fit in a unique
source file (e.g.
          subsystem description).
        - Source code is more readable without big blocks of comments.

    * Documentation files have a well defined XML structure.
        - Provides developers a clear view of what has to be documented and how.
        - Documentation can be edited using standard XML editors.
        - It can be obtained lots of human readable documentation
formats (LaTeX, HTML, ...)
          from XML documents.
        - Documentation can be independent from programming language.

My initial idea of LXD is a system composed by the XML documents
definitions and a set of tools to ease the management of XML
documentation. To simplify the problem, the first approach will be
focused on projects written in C language. As I said in my previous
post, there is a presentation of the project at
http://lxd.sourceforge.net/.

The main aspects that I expect to discuss for user requirements
analysis are the XML documents definitions and also useful tools for
this system.

Best regards,

--
Guillermo

      reply	other threads:[~2006-03-22 10:45 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-03-21 10:12 Guillermo López Alejos
2006-03-21 23:15 ` Sam Vilain
2006-03-22 10:45   ` Guillermo López Alejos [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4fec73ca0603220245y72e66279jeaf93a944334a879@mail.gmail.com \
    --to=glalejos@gmail.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sam@vilain.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®