Skip to content

Commit 8343769

Browse files
committed
---
yaml --- r: 138104 b: refs/heads/try c: e2fed74 h: refs/heads/master v: v3
1 parent 2aac80c commit 8343769

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

[refs]

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
refs/heads/master: b6e0d3a5bf4c88650a22f605f822e02c6b163580
33
refs/heads/snap-stage1: e33de59e47c5076a89eadeb38f4934f58a3618a6
44
refs/heads/snap-stage3: 78a7676898d9f80ab540c6df5d4c9ce35bb50463
5-
refs/heads/try: b2949ae543e5a7a1e2b5543aff8e4252f1aab41c
5+
refs/heads/try: e2fed746c2b0d40707900fe9091868cc7d9ed94b
66
refs/tags/release-0.1: 1f5c5126e96c79d22cb7862f75304136e204f105
77
refs/heads/ndm: f3868061cd7988080c30d6d5bf352a5a5fe2460b
88
refs/heads/try2: 147ecfdd8221e4a4d4e090486829a06da1e0ca3c

branches/try/src/doc/README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Dependencies
1+
# Rust documentations
2+
3+
## Dependencies
24

35
[Pandoc](http://johnmacfarlane.net/pandoc/installing.html), a universal
46
document converter, is required to generate docs as HTML from Rust's
@@ -10,7 +12,7 @@ docs from the master (English) docs.
1012
[GNU gettext](http://www.gnu.org/software/gettext/) is required for managing
1113
the translation data.
1214

13-
# Building
15+
## Building
1416

1517
To generate all the docs, just run `make docs` from the root of the repository.
1618
This will convert the distributed Markdown docs to HTML and generate HTML doc
@@ -24,7 +26,7 @@ rustdoc --output html-doc/ --output-format html ../src/libstd/path.rs
2426

2527
(This, of course, requires a working build of the `rustdoc` tool.)
2628

27-
# Additional notes
29+
## Additional notes
2830

2931
To generate an HTML version of a doc from Markdown manually, you can do
3032
something like:
@@ -33,37 +35,39 @@ something like:
3335
pandoc --from=markdown --to=html5 --number-sections -o reference.html reference.md
3436
~~~~
3537

36-
(reference.md being the Rust Reference Manual.)
38+
(`reference.md` being the Rust Reference Manual.)
3739

3840
The syntax for pandoc flavored markdown can be found at:
39-
http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
41+
42+
- http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown
4043

4144
A nice quick reference (for non-pandoc markdown) is at:
42-
http://kramdown.rubyforge.org/quickref.html
4345

44-
# Notes for translators
46+
- http://kramdown.gettalong.org/quickref.html
47+
48+
## Notes for translators
4549

4650
Notice: The procedure described below is a work in progress. We are working on
4751
translation system but the procedure contains some manual operations for now.
4852

49-
To start the translation for a new language, see po4a.conf at first.
53+
To start the translation for a new language, see `po4a.conf` at first.
5054

51-
To generate .pot and .po files, do something like:
55+
To generate `.pot` and `.po` files, do something like:
5256

5357
~~~~
5458
po4a --copyright-holder="The Rust Project Developers" \
5559
--package-name="Rust" \
56-
--package-version="0.11.0" \
60+
--package-version="0.13.0" \
5761
-M UTF-8 -L UTF-8 \
5862
src/doc/po4a.conf
5963
~~~~
6064

61-
(the version number must be changed if it is not 0.11.0 now.)
65+
(the version number must be changed if it is not `0.13.0` now.)
6266

63-
Now you can translate documents with .po files, commonly used with gettext. If
67+
Now you can translate documents with `.po` files, commonly used with gettext. If
6468
you are not familiar with gettext-based translation, please read the online
6569
manual linked from http://www.gnu.org/software/gettext/ . We use UTF-8 as the
66-
file encoding of .po files.
70+
file encoding of `.po` files.
6771

6872
When you want to make a commit, do the command below before staging your
6973
change:
@@ -79,4 +83,4 @@ for f in src/doc/po/**/*.po; do
7983
done
8084
~~~~
8185

82-
This removes untranslated entries from .po files to save disk space.
86+
This removes untranslated entries from `.po` files to save disk space.

0 commit comments

Comments
 (0)