Documentation: make boxes more boxy 03/221803/5
authorMichal Bloch <m.bloch@samsung.com>
Tue, 7 Jan 2020 12:48:39 +0000 (13:48 +0100)
committerMichal Bloch <m.bloch@partner.samsung.com>
Tue, 18 Feb 2020 11:49:25 +0000 (11:49 +0000)
Change-Id: I86765ca0912acee188bab31b5b3c0509066f827b
Signed-off-by: Michal Bloch <m.bloch@samsung.com>
src/logger/log_storage.c

index a6a6c41..7264759 100644 (file)
  * - getting new log entry
  * - getting how much (unread) data (in bytes) is ready to read in the storage.
  *
- *       :----------:    :--------:    :--------:    :--------:
- *       | storage  | -> | reader | -> | reader | -> | reader | (readers that have not started reading yet)
- *       :----------|    :--------:    :--------:    :--------:
- *            |
+ *       ┌──────────┐    ┌────────┐    ┌────────┐    ┌────────┐
+ *       │ storage  │ ─> │ reader │ ─> │ reader │ ─> │ reader │ (readers that have not started reading yet)
+ *       └────┬─────┘    └────────┘    └────────┘    └────────┘
+ *            
  *            v
- *    -> :-----------| -> :-----------| -> :-----------| -> :-----------| ->
- * ...   | log entry |    | log entry |    | log entry |    | log entry |   ...
- *    <- :-----------: <- :-----------: <- :-----------: <- :-----------: <-
- *         ^    |           ^    |                            ^    |
- *         |    v           |    v                            |    v
- *         | :--------:     | :--------:                      | :--------:
- *         \-| reader |     \-| reader |                      \-| reader |
- *         | :--------:       :--------:                      | :--------:
- *         |    |                                             |    |
- *         |    v                                             |    v
- *         | :--------:                                       | :--------:
- *         \-| reader |                                       \-| reader |
- *         | :--------:                                         :--------:
- *         |    |                                                   These two readers
- *         |    v                                                   have already read all four logs.
- *         | :--------:
- *         \-| reader |
- *           :--------:
+ *    ─> ┌───────────┐ ─> ┌───────────┐ ─> ┌───────────┐ ─> ┌───────────┐ ─>
+ * ...   │ log entry │    │ log entry │    │ log entry │    │ log entry │   ...
+ *    <─ └──────┬────┘ <─ └──────┬────┘ <─ └───────────┘ <─ └──────┬────┘ <─
+ *         ^    │           ^    │                            ^    │
+ *         │    v           │    v                            │    v
+ *         │ ┌────────┐     │ ┌────────┐                      │ ┌────────┐
+ *         ├─┤ reader │     └─┤ reader │                      ├─┤ reader │
+ *         │ └────────┘       └────────┘                      │ └────────┘
+ *         │    │                                             │    │
+ *         │    v                                             │    v
+ *         │ ┌────────┐                                       │ ┌────────┐
+ *         ├─┤ reader │                                       └─┤ reader │
+ *         │ └────────┘                                         └────────┘
+ *         │    │                                                   These two readers
+ *             v                                                   have already read all four logs.
+ *         │ ┌────────┐
+ *         └─┤ reader │
+ *           └────────┘
  *
  *
  * When a pushed log passes an entry with active readers, they are notified about the log by a registered