Skip to content

Commit 7fa2094

Browse files
committed
Convert documentation to markdown.
Markdown is more readable in a text editor and when hosted on GitHub is more readable than HTML. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=148830423
1 parent ea175e2 commit 7fa2094

File tree

12 files changed

+890
-1044
lines changed

12 files changed

+890
-1044
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Authors: Sanjay Ghemawat ([email protected]) and Jeff Dean ([email protected])
1616
* External activity (file system operations etc.) is relayed through a virtual interface so users can customize the operating system interactions.
1717

1818
# Documentation
19-
[LevelDB library documentation](https://rawgit.com/google/leveldb/master/doc/index.html) is online and bundled with the source code.
19+
[LevelDB library documentation](https://rawgit.com/google/leveldb/master/doc/index.md) is online and bundled with the source code.
2020

2121

2222
# Limitations
@@ -113,29 +113,30 @@ by the one or two disk seeks needed to fetch the data from disk.
113113
Write performance will be mostly unaffected by whether or not the
114114
working set fits in memory.
115115

116-
readrandom : 16.677 micros/op; (approximately 60,000 reads per second)
117-
readseq : 0.476 micros/op; 232.3 MB/s
118-
readreverse : 0.724 micros/op; 152.9 MB/s
116+
readrandom : 16.677 micros/op; (approximately 60,000 reads per second)
117+
readseq : 0.476 micros/op; 232.3 MB/s
118+
readreverse : 0.724 micros/op; 152.9 MB/s
119119

120120
LevelDB compacts its underlying storage data in the background to
121121
improve read performance. The results listed above were done
122122
immediately after a lot of random writes. The results after
123123
compactions (which are usually triggered automatically) are better.
124124

125-
readrandom : 11.602 micros/op; (approximately 85,000 reads per second)
126-
readseq : 0.423 micros/op; 261.8 MB/s
127-
readreverse : 0.663 micros/op; 166.9 MB/s
125+
readrandom : 11.602 micros/op; (approximately 85,000 reads per second)
126+
readseq : 0.423 micros/op; 261.8 MB/s
127+
readreverse : 0.663 micros/op; 166.9 MB/s
128128

129129
Some of the high cost of reads comes from repeated decompression of blocks
130130
read from disk. If we supply enough cache to the leveldb so it can hold the
131131
uncompressed blocks in memory, the read performance improves again:
132132

133-
readrandom : 9.775 micros/op; (approximately 100,000 reads per second before compaction)
134-
readrandom : 5.215 micros/op; (approximately 190,000 reads per second after compaction)
133+
readrandom : 9.775 micros/op; (approximately 100,000 reads per second before compaction)
134+
readrandom : 5.215 micros/op; (approximately 190,000 reads per second after compaction)
135135

136136
## Repository contents
137137

138-
See doc/index.html for more explanation. See doc/impl.html for a brief overview of the implementation.
138+
See [doc/index.md](doc/index.md) for more explanation. See
139+
[doc/impl.md](doc/impl.md) for a brief overview of the implementation.
139140

140141
The public interface is in include/*.h. Callers should not include or
141142
rely on the details of any other header files in this package. Those
@@ -148,7 +149,7 @@ Guide to header files:
148149
* **include/options.h**: Control over the behavior of an entire database,
149150
and also control over the behavior of individual reads and writes.
150151

151-
* **include/comparator.h**: Abstraction for user-specified comparison function.
152+
* **include/comparator.h**: Abstraction for user-specified comparison function.
152153
If you want just bytewise comparison of keys, you can use the default
153154
comparator, but clients can write their own comparator implementations if they
154155
want custom ordering (e.g. to handle different character encodings, etc.)
@@ -165,7 +166,7 @@ length into some other byte array.
165166
* **include/status.h**: Status is returned from many of the public interfaces
166167
and is used to report success and various kinds of errors.
167168

168-
* **include/env.h**:
169+
* **include/env.h**:
169170
Abstraction of the OS environment. A posix implementation of this interface is
170171
in util/env_posix.cc
171172

db/log_format.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// found in the LICENSE file. See the AUTHORS file for names of contributors.
44
//
55
// Log format information shared by reader and writer.
6-
// See ../doc/log_format.txt for more detail.
6+
// See ../doc/log_format.md for more detail.
77

88
#ifndef STORAGE_LEVELDB_DB_LOG_FORMAT_H_
99
#define STORAGE_LEVELDB_DB_LOG_FORMAT_H_

doc/doc.css

Lines changed: 0 additions & 89 deletions
This file was deleted.

doc/impl.html

Lines changed: 0 additions & 213 deletions
This file was deleted.

0 commit comments

Comments
 (0)