Skip to content

Commit ac9468f

Browse files
committed
Add auto-generated stable ID and hash
According to ELISA proposal, each requirement shall have a unique stable ID that never changes, and a hash ID to detect when requirement content was changed. The hash is conceptually calculated as: echo -nE "${PROJECT}${FILE_PATH}${INSTANCE}${CODE}" | sha256sum StrictDoc can auto-generate these IDs with strictdoc manage auto-uid . This commit adds the result from running the command. Signed-off-by: Tobias Deiminger <tobias.deiminger@linutronix.de>
1 parent 66fcb59 commit ac9468f

4 files changed

Lines changed: 43 additions & 24 deletions

File tree

Documentation/requirements/charmisc.sdoc

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,38 @@ OPTIONS:
1111
IMPORT_FROM_FILE: grammar.sgra
1212

1313
[[SECTION]]
14+
MID: 1ff90054888e471296abb14c481cce34
1415
TITLE: Low-Level Requirements
1516

1617
[[SECTION]]
18+
MID: 9ffc6d504c8e41a89356b60f2d1d1f84
1719
TITLE: devmem
1820

1921
[[SECTION]]
22+
MID: 48874ce7f5c84922832640965298160f
2023
TITLE: Requirements
2124

2225
[REQUIREMENT]
23-
MID: drivers/char/mem.c:read_mem
26+
MID: 8e4d91486c90ba6611165431cfde9a9aeeb65c8aa520c9cc280031117cb60014
27+
HASH: e06c773fa9ac085073414a8acdbd3a2fdaea3a90af0a6873462876c1c55ce682
2428
SPDX-Req-Sys: Character Drivers and Misc
2529
TITLE: read_mem
2630

2731
[REQUIREMENT]
28-
MID: drivers/char/mem.c:write_mem
32+
MID: 96f50f5765ae532430e49a15fd73c15a1999d0bae601d147492a42c9548419a4
33+
HASH: 83f393fd3b6191e7ad88da40799254f4227893e7212c59e9a41ff429b1eba555
2934
SPDX-Req-Sys: Character Drivers and Misc
3035
TITLE: write_mem
3136

3237
[REQUIREMENT]
33-
MID: drivers/char/mem.c:mmap_mem
38+
MID: 281f72056773634770157361548741c2c60c1049201ce0e2378eb2ffbc225845
39+
HASH: 12f2a3571b30462c24cd92d073513eba9e91a052a45057073b1c17de2584546f
3440
SPDX-Req-Sys: Character Drivers and Misc
3541
TITLE: mmap_mem
3642

3743
[REQUIREMENT]
38-
MID: drivers/char/mem.c:memory_lseek
44+
MID: ac6fcf9ccb6d2dfa66b3751776223ee8dc84ca0357a461827fba39287a80b4a9
45+
HASH: 17745d554ee1aca155176037541afce34a4c901070a0bdc84d114e8a147a8052
3946
SPDX-Req-Sys: Character Drivers and Misc
4047
TITLE: memory_lseek
4148
COMMENT: >>>
@@ -49,18 +56,21 @@ it has no meaning, so passing orig equal to SEEK_END returns -EINVAL.
4956
<<<
5057

5158
[REQUIREMENT]
52-
MID: drivers/char/mem.c:open_port
59+
MID: 6b1f5e04b2b32ed30915d36eafcd4be34913e8b1427b43cbfc75f0395b99b8c8
60+
HASH: d236556a51f674d4e8b40b7e942b552e2944f21edee75826b3f17b5d4486413f
5361
SPDX-Req-Sys: Character Drivers and Misc
5462
TITLE: open_port
5563

5664
[REQUIREMENT]
57-
MID: drivers/char/mem.c:memory_open
65+
MID: b542fb780fb69bf529ff88d29aad7186590fb9c4d3a8e69b93c22fb861ed05eb
66+
HASH: 7e47f36178f4b7e69ecb2d9f1f08c1d126afac6d1bedf260a8021a318f59fc5b
5867
SPDX-Req-Sys: Character Drivers and Misc
5968
TITLE: memory_open
6069

6170
[[/SECTION]]
6271

6372
[[SECTION]]
73+
MID: ca10a07926aa405bb1c7f5c47d4e35c1
6474
TITLE: Tests
6575

6676
[TEST]

Documentation/requirements/tracing.sdoc

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,50 +11,59 @@ OPTIONS:
1111
IMPORT_FROM_FILE: grammar.sgra
1212

1313
[[SECTION]]
14+
MID: 1efe0668db3c4c21b906e2f144693414
1415
TITLE: Low-Level Requirements
1516

1617
[[SECTION]]
18+
MID: a6e95798039e4953b8ab8b8f29466646
1719
TITLE: Event Tracing
1820

1921
[[SECTION]]
22+
MID: fa7d6d252a654efab60d04c6b1719b55
2023
TITLE: Requirements
2124

2225
[REQUIREMENT]
23-
MID: kernel/trace/trace_events.c:__ftrace_event_enable_disable
26+
MID: 9ff65ac6b7a30ace7847eecb2eb8ebd10110d029d043fc7acf51d27d3931de9e
27+
HASH: e8ee84ca42f5626ca9636abb53ded027708fdaabc99c8b935c016dda53130d81
2428
SPDX-Req-Sys: Tracing
2529
TITLE: __ftrace_event_enable_disable
2630

2731
[REQUIREMENT]
28-
MID: kernel/trace/trace_events.c:__ftrace_set_clr_event_nolock
32+
MID: a43f6b356ccff69af73a0ecd5fc7bab37fd385d9b314851e2d30068b0acf8309
33+
HASH: e51e19a73c8c491cc21da2c53684566c0ceebe26b123fdc16bf859ee6606c43a
2934
SPDX-Req-Sys: Tracing
3035
TITLE: __ftrace_set_clr_event_nolock
3136
RELATIONS:
3237
- TYPE: Parent
3338
VALUE: kernel/trace/trace_events.c:__ftrace_event_enable_disable
3439

3540
[REQUIREMENT]
36-
MID: kernel/trace/trace_events.c:trace_set_clr_event
41+
MID: c6d0b5c24977d55a7943f7977bc0246d7f73b5bd09a342a718bf9eb97682d00e
42+
HASH: f8f29e7907a29e320df18a0950fa64b161dcd5cdd7960b44896e396bccb437c2
3743
SPDX-Req-Sys: Tracing
3844
TITLE: trace_set_clr_event
3945
RELATIONS:
4046
- TYPE: Parent
4147
VALUE: kernel/trace/trace_events.c:__ftrace_set_clr_event_nolock
4248

4349
[REQUIREMENT]
44-
MID: kernel/trace/trace_events.c:trace_array_set_clr_event
50+
MID: 716e13796b05a34269db4b4d092bccf8fb1cb80b5ce2b36913f390d7a4a2f437
51+
HASH: 9d9e9749fcdea49bddbf04196c6f91fe0402dcd5abb42087358a2bb4188dee9b
4552
SPDX-Req-Sys: Tracing
4653
TITLE: trace_array_set_clr_event
4754
RELATIONS:
4855
- TYPE: Parent
4956
VALUE: kernel/trace/trace_events.c:__ftrace_set_clr_event_nolock
5057

5158
[REQUIREMENT]
52-
MID: kernel/trace/trace_events.c:event_enable_read
59+
MID: a59707adf089565c755475e5a4b369341f35fa18ceab91fec0ceb9b434f040cc
60+
HASH: cfecd529348a4e4b03c4df242bf53845e108ab1347364da515e0dbbaa0ddb1ef
5361
SPDX-Req-Sys: Tracing
5462
TITLE: event_enable_read
5563

5664
[REQUIREMENT]
57-
MID: kernel/trace/trace_events.c:event_enable_write
65+
MID: d6675ab590424b23bd39aa5c799fd3bd0d3f141dbced50ed336203d1dc31b849
66+
HASH: a87575aecf3aa1cd0b6331c326ce148e818e1f6b44a0d0827b815d3e47ae8f36
5867
SPDX-Req-Sys: Tracing
5968
TITLE: event_enable_write
6069

drivers/char/mem.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ static inline bool should_stop_iteration(void)
7676
}
7777

7878
/**
79-
* SPDX-Req-ID: drivers/char/mem.c:read_mem
79+
* SPDX-Req-ID: 8e4d91486c90ba6611165431cfde9a9aeeb65c8aa520c9cc280031117cb60014
8080
* SPDX-Req-Text:
8181
* read_mem - read from physical memory (/dev/mem).
8282
* @file: struct file associated with /dev/mem.
@@ -216,7 +216,7 @@ static ssize_t read_mem(struct file *file, char __user *buf,
216216
}
217217

218218
/**
219-
* SPDX-Req-ID: drivers/char/mem.c:write_mem
219+
* SPDX-Req-ID: 96f50f5765ae532430e49a15fd73c15a1999d0bae601d147492a42c9548419a4
220220
* SPDX-Req-Text:
221221
* write_mem - write to physical memory (/dev/mem).
222222
* @file: struct file associated with /dev/mem.
@@ -424,7 +424,7 @@ static const struct vm_operations_struct mmap_mem_ops = {
424424
};
425425

426426
/**
427-
* SPDX-Req-ID: drivers/char/mem.c:mmap_mem
427+
* SPDX-Req-ID: 281f72056773634770157361548741c2c60c1049201ce0e2378eb2ffbc225845
428428
* SPDX-Req-Text:
429429
* mmap_mem - map physical memory into user space (/dev/mem).
430430
* @file: file structure for the device.
@@ -705,7 +705,7 @@ static loff_t null_lseek(struct file *file, loff_t offset, int orig)
705705
}
706706

707707
/**
708-
* SPDX-Req-ID: drivers/char/mem.c:memory_lseek
708+
* SPDX-Req-ID: ac6fcf9ccb6d2dfa66b3751776223ee8dc84ca0357a461827fba39287a80b4a9
709709
* SPDX-Req-Text:
710710
* memory_lseek - change the file position.
711711
* @file: file structure for the device.
@@ -777,7 +777,7 @@ static loff_t memory_lseek(struct file *file, loff_t offset, int orig)
777777
}
778778

779779
/**
780-
* SPDX-Req-ID: drivers/char/mem.c:open_port
780+
* SPDX-Req-ID: 6b1f5e04b2b32ed30915d36eafcd4be34913e8b1427b43cbfc75f0395b99b8c8
781781
* SPDX-Req-Text:
782782
* open_port - open the I/O port device (/dev/port).
783783
* @inode: inode of the device file.
@@ -917,7 +917,7 @@ static const struct memdev {
917917
};
918918

919919
/**
920-
* SPDX-Req-ID: drivers/char/mem.c:memory_open
920+
* SPDX-Req-ID: b542fb780fb69bf529ff88d29aad7186590fb9c4d3a8e69b93c22fb861ed05eb
921921
* SPDX-Req-Text:
922922
* memory_open - set the filp f_op to the memory device fops and invoke open().
923923
* @inode: inode of the device file.

kernel/trace/trace_events.c

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,7 @@ void trace_event_enable_tgid_record(bool enable)
764764
}
765765

766766
/**
767-
* SPDX-Req-ID: kernel/trace/trace_events.c:__ftrace_event_enable_disable
767+
* SPDX-Req-ID: 9ff65ac6b7a30ace7847eecb2eb8ebd10110d029d043fc7acf51d27d3931de9e
768768
* SPDX-Req-Text:
769769
* __ftrace_event_enable_disable - enable or disable a trace event
770770
* @file: trace event file associated with the event.
@@ -1353,7 +1353,7 @@ static void remove_event_file_dir(struct trace_event_file *file)
13531353
}
13541354

13551355
/**
1356-
* SPDX-Req-ID: kernel/trace/trace_events.c:__ftrace_set_clr_event_nolock
1356+
* SPDX-Req-ID: a43f6b356ccff69af73a0ecd5fc7bab37fd385d9b314851e2d30068b0acf8309
13571357
* SPDX-Req-Text:
13581358
* __ftrace_set_clr_event_nolock - enable or disable an event within a system.
13591359
* @tr: target trace_array containing the events list.
@@ -1538,7 +1538,7 @@ int ftrace_set_clr_event(struct trace_array *tr, char *buf, int set)
15381538
}
15391539

15401540
/**
1541-
* SPDX-Req-ID: kernel/trace/trace_events.c:trace_set_clr_event
1541+
* SPDX-Req-ID: c6d0b5c24977d55a7943f7977bc0246d7f73b5bd09a342a718bf9eb97682d00e
15421542
* SPDX-Req-Text:
15431543
* trace_set_clr_event - enable or disable an event within a system.
15441544
* @system: system name (NULL for any system).
@@ -1581,7 +1581,7 @@ int trace_set_clr_event(const char *system, const char *event, int set)
15811581
EXPORT_SYMBOL_GPL(trace_set_clr_event);
15821582

15831583
/**
1584-
* SPDX-Req-ID: kernel/trace/trace_events.c:trace_array_set_clr_event
1584+
* SPDX-Req-ID: 716e13796b05a34269db4b4d092bccf8fb1cb80b5ce2b36913f390d7a4a2f437
15851585
* SPDX-Req-Text:
15861586
* trace_array_set_clr_event - enable or disable an event within a system for
15871587
* a trace array.
@@ -1904,7 +1904,7 @@ static void p_stop(struct seq_file *m, void *p)
19041904
}
19051905

19061906
/**
1907-
* SPDX-Req-ID: kernel/trace/trace_events.c:event_enable_read
1907+
* SPDX-Req-ID: a59707adf089565c755475e5a4b369341f35fa18ceab91fec0ceb9b434f040cc
19081908
* SPDX-Req-Text:
19091909
* event_enable_read - read from a trace event file to retrieve its status.
19101910
* @filp: file pointer associated with the target trace event.
@@ -1980,7 +1980,7 @@ event_enable_read(struct file *filp, char __user *ubuf, size_t cnt,
19801980
}
19811981

19821982
/**
1983-
* SPDX-Req-ID: kernel/trace/trace_events.c:event_enable_write
1983+
* SPDX-Req-ID: d6675ab590424b23bd39aa5c799fd3bd0d3f141dbced50ed336203d1dc31b849
19841984
* SPDX-Req-Text:
19851985
* event_enable_write - write to a trace event file to enable/disable it.
19861986
* @filp: file pointer associated with the target trace event.

0 commit comments

Comments
 (0)