sdbfs/doc: basic document layout, not contents yet

2b67a9e7 · Alessandro Rubini · 7de9a85a · 2b67a9e7 · 2b67a9e7
Commit 2b67a9e7 authored Aug 22, 2012 by Alessandro Rubini
Hide whitespace changes
Inline Side-by-side

Showing with 76 additions and 0 deletions

.gitignore sdbfs/doc/.gitignore +16 -0

sdbfs.in sdbfs/doc/sdbfs.in +60 -0

No files found.
--- a/sdbfs/doc/.gitignore
+++ b/sdbfs/doc/.gitignore
+*~
+*.aux
+*.cp
+*.cps
+*.fn
+*.html
+*.info
+*.ky
+*.log
+*.pdf
+*.pg
+*.texi
+*.toc
+*.tp
+/*.txt
+*.vr
--- a/sdbfs/doc/sdbfs.in
+++ b/sdbfs/doc/sdbfs.in
+\input texinfo    @c -*-texinfo-*-
+%
+% sdbfs.in - main file for the documentation
+%
+%%%%
+
+%------------------------------------------------------------------------------
+%
+%                         NOTE FOR THE UNAWARE USER
+%                         =========================
+%
+%    This file is a texinfo source. It isn't the binary file of some strange
+%    editor of mine. If you want ASCII, you should "make sdbfs.txt".
+%
+%------------------------------------------------------------------------------
+
+%
+% This is not a conventional info file...
+% I use three extra features:
+%   - The '%' as a comment marker, if at beginning of line ("\%" -> "%")
+%   - leading blanks are allowed (this is something I can't live without)
+%   - braces are automatically escaped when they appear in example blocks
+%
+
+@comment %**start of header
+@documentlanguage en
+@setfilename sdbfs.info
+@settitle sdbfs
+@iftex
+@afourpaper
+@end iftex
+@paragraphindent none
+@comment %**end of header
+
+@setchapternewpage off
+
+@set update-month August 2012
+
+@finalout
+
+@titlepage
+@title SDBFS
+@subtitle @value{update-month}
+@subtitle A Flash File-system based on SDB data structures
+@author Alessandro Rubini for CERN (BE-CO-HT)
+@end titlepage
+@headings single
+
+@c ##########################################################################
+@iftex
+@contents
+@end iftex
+
+@c ##########################################################################
+@node Top
+@top Introduction
+
+@bye
+
+@c  LocalWords:  Alessandro Rubini CERN iftex texinfo sdbfs