crashpad/doc/support/asciidoc.conf
Mark Mentovai 332e8219ed Migrate content from wiki.
The wiki existed at https://code.google.com/p/crashpad/wiki, but given
Google Code Project Hosting’s impending shutdown[1], it’s prudent to
move wiki documents into the source code repository.

This change moves the existing contents of doc into doc/support, to make
way for documentation in doc. The two existing wiki pages, ProjectStatus
and DevelopingCrashpad, are converted to AsciiDoc format (a fairly
straightforward conversion) and checked in to doc. generate_asciidoc.sh
is updated to produce HTML output from these files. The generated HTML
will show up at http://docs.crashpad.googlecode.com/git/doc/. Note that
generated HTML is still hosted on Google Code Project Hosting, but it’ll
be easy to find a new home for them.

[1]
http://google-opensource.blogspot.com/2015/03/farewell-to-google-code.html

R=rsesek@chromium.org

Review URL: https://codereview.chromium.org/1055523002
2015-04-01 12:39:53 -04:00

59 lines
2.2 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Copyright 2015 The Crashpad Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
[miscellaneous]
# AsciiDoc uses \r\n by default.
newline=\n
# The default AsciiDoc lang-en.conf uses docdate and doctime for the
# last-updated line in footer-text. These attributes are taken from the files
# mtime and cannot be overridden. For a git-based project, the date of the last
# revision is desirable, so change this to use git_date, an attribute that can
# be computed and passed in by the script that runs AsciiDoc. For man pages, use
# the mansource and manversion attributes instead of the hard-coded “Version”
# string and revnumber attribute, so that the version will appear as “Crashpad
# 0.7.0” as it does in “man” output.
ifdef::basebackend-html[]
[footer-text]
ifdef::doctype-manpage[]
{mansource=Version} {manversion={revnumber}}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>}
endif::doctype-manpage[]
ifndef::doctype-manpage[]
Version {revnumber}{basebackend-xhtml11?<br />}{basebackend-xhtml11=<br>}
endif::doctype-manpage[]
Last updated {git_date}
endif::basebackend-html[]
# The man_link macro was inspired by gits linkgit macro. See
# https://github.com/git/git/blob/master/Documentation/asciidoc.conf.
ifdef::doctype-manpage[]
[macros]
(?su)[\\]?(?P<name>man_link):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
ifdef::backend-docbook[]
[man_link-inlinemacro]
{0%{target}}
{0#<citerefentry>}
{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
{0#</citerefentry>}
endif::backend-docbook[]
ifdef::basebackend-html[]
[man_link-inlinemacro]
<a href="{target}.html">{target}{0?({0})}</a>
endif::basebackend-html[]
endif::doctype-manpage[]