public inbox for linux-xfs@vger.kernel.org
 help / color / mirror / Atom feed
From: Eric Sandeen <sandeen@redhat.com>
To: xfs-oss <xfs@oss.sgi.com>
Subject: [ANNOUNCE] updated xfs documentation available
Date: Mon, 23 Aug 2010 11:22:39 -0500	[thread overview]
Message-ID: <4C72A04F.20104@redhat.com> (raw)

Just as an FYI, we've converted some of the older SGI XFS documentation
to XML/Docbook/Publican[1] format, and it's now available on xfs.org; see
http://xfs.org/index.php/XFS_Papers_and_Documentation

particularly the 3 links at the top, 

    * XFS User Guide 

    * XFS File System Structure 

    * XFS Training Labs 

In addition to the XML conversion, much of the documentation has
been updated & corrected compared to the original docs.

This should be good material for anyone using, developing, or supporting
XFS.  If omissions or errors are found, we'd be happy to accept
patches against the XML source for the docs, found at
http://git.kernel.org/?p=fs/xfs/xfsdocs-xml-dev.git;a=summary

In addition, using that git repo + publican allows one to create
the documentation in various other forms such as PDFs, txt,
and epub.

Thanks!

-Eric

[1] https://fedorahosted.org/publican/

_______________________________________________
xfs mailing list
xfs@oss.sgi.com
http://oss.sgi.com/mailman/listinfo/xfs

             reply	other threads:[~2010-08-23 16:22 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-08-23 16:22 Eric Sandeen [this message]
2010-08-23 22:03 ` [ANNOUNCE] updated xfs documentation available Kinzel, David
2010-08-23 22:05   ` Eric Sandeen

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=4C72A04F.20104@redhat.com \
    --to=sandeen@redhat.com \
    --cc=xfs@oss.sgi.com \
    /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