Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

Commit e280115

Browse files
committed
clarify depslog overview
1 parent e801e67 commit e280115

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

src/deps_log.h

+5-4
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ struct Node;
2727
struct State;
2828

2929
/// As build commands run they can output extra dependency information
30-
/// (e.g. header dependencies for C source) via a pipe. DepsLog collects
31-
/// that information at build time and reloads it at startup.
30+
/// (e.g. header dependencies for C source) dynamically. DepsLog collects
31+
/// that information at build time and uses it for subsequent builds.
3232
///
33-
/// The on-disk format is based on two primary constraints:
33+
/// The on-disk format is based on two primary design constraints:
3434
/// - it must be written to as a stream (during the build, which may be
3535
/// interrupted);
3636
/// - it can be read all at once on startup. (Alternative designs, where
@@ -43,7 +43,8 @@ struct State;
4343
/// There's about 10k files worth of dependencies that reference about
4444
/// 40k total paths totalling 2mb of unique strings.
4545
///
46-
/// Based on these above, the file is structured as a sequence of records.
46+
/// Based on these stats, here's the current design.
47+
/// The file is structured as version header followed by a sequence of records.
4748
/// Each record is either a path string or a dependency list.
4849
/// Numbering the path strings in file order gives them dense integer ids.
4950
/// A dependency list maps an output id to a list of input ids.

0 commit comments

Comments
 (0)