docs: my_proc_file_ops from :c:func: to :c:data: #214
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Alexandra Sandulescu <[email protected]>
Signed-off-by: Alexandra Sandulescu <[email protected]>
Signed-off-by: Alexandra Sandulescu <[email protected]>
* use maximum 80 characters per line * use specific c constructs (:c:type``, :c:func``, etc) instead of :code: or elixir links * remove end of line whitespace Signed-off-by: Anda Nicolae <[email protected]> Signed-off-by: Octavian Purdila <[email protected]>
Signed-off-by: Alexandra Sandulescu <[email protected]>
Lab07 presents the API used by the kernel when working with block devices. It also explains the core structure of a generic block device driver. Signed-off-by: Anda Nicolae <[email protected]>
* add removed entry from index.rst * remove unneeded section and bump up the remaining ones * use "Submit" instead of "Transmit" * use "type" instead of "struct" in Sphinx syntax * parse line > 80 Signed-off-by: Anda Nicolae <[email protected]>
Remove reference to deprecated field struct block_device *bi_bdev from struct bio and add instead struct gendisk *bi_disk field. Signed-off-by: Anda Nicolae <[email protected]>
Signed-off-by: Razvan Deaconescu <[email protected]>
* fix grammar issues
* use Sphinx syntax when needed to highlight C structures,
functions, macros etc.
* parse line > 80
Signed-off-by: Anda Nicolae <[email protected]>
One can use this skeleton to start implementing e100 driver assignment. Signed-off-by: Daniel Baluta <[email protected]>
Signed-off-by: Daniel Baluta <[email protected]>
Change network for second interface because nttcp is compiled with hardcoded listening addresss (172.30.0.1). TODO: recompile nttcp to support configurable ip address. Signed-off-by: Daniel Baluta <[email protected]>
Signed-off-by: Razvan Deaconescu <[email protected]>
Signed-off-by: Daniel Baluta <[email protected]>
Signed-off-by: Daniel Baluta <[email protected]>
Signed-off-by: Razvan Deaconescu <[email protected]>
Makefile is to be used for building the test suite executable instead of Makefile.checker.
Because we are using virtio the device name is vd* not sd*. Also, because it is the fourth disk the name will be /dev/vdd. Signed-off-by: Diana Ungureanu <[email protected]>
Signed-off-by: Daniel Baluta <[email protected]>
Signed-off-by: SeongJae Park <[email protected]>
Signed-off-by: SeongJae Park <[email protected]>
Signed-off-by: SeongJae Park <[email protected]>
Some of the documents are written under assumption of this repo is
cloned as '~/src/linux' while others assumes '~/so2/linux'. This commit
makes all documents to use 'src/', as it is more widely used.
$ git grep src/linux Documentation/teaching | wc -l
58
$ git grep so2/linux Documentation/teaching | wc -l
19
Signed-off-by: SeongJae Park <[email protected]>
Signed-off-by: SeongJae Park <[email protected]>
Signed-off-by: SeongJae Park <[email protected]>
The document says writing to '/proc/hello_kdb_break' increments 'kdb_write_address', but the code just write 1 to 'write_address'. This commit makes the code to work as explained in the document. Signed-off-by: SeongJae Park <[email protected]>
Commit 44b5f01 ("Documentation/teaching: Use 'src/linux' instead of 'so2/linux'") missed fixing directory creation command. This commit fixes it. Signed-off-by: SeongJae Park <[email protected]>
the `inte i;` here clashes with `struct bvec_iter i;` and is not used
Signed-off-by: SeongJae Park <[email protected]>
…tation dyndbg option example for 'format' has unnecessary indentation. This commit removes it. Signed-off-by: SeongJae Park <[email protected]>
In 'Dyndbg Options' section, verbatim (``*``) is applied to all keywords but 'line'. This commit makes it consistently applied. Signed-off-by: SeongJae Park <[email protected]>
In 'Dyndbg Options' section, it explains 'I', 'M', and 'T' flags, which don't exist. According to the explanations, those should be 'l', 'm', and 't'. This commit fixes those. Signed-off-by: SeongJae Park <[email protected]>
Signed-off-by: SeongJae Park <[email protected]>
Seems reader-writer spinlock interfaces intended to be displayed as a bullets list. However, the syntax is wrongly applied. Moreover, it would seems natural to displayed inside the sentence, as those for spinlock are. So, this commit makes the interfaces to be naturally listed in the sentence. Signed-off-by: SeongJae Park <[email protected]>
…bles' section Signed-off-by: SeongJae Park <[email protected]>
So it doesn't render as `my_proc_file_ops`
tavip
reviewed
Oct 25, 2020
| @@ -446,7 +446,7 @@ that called the :c:func:`read` on that file. | |||
|
|
|||
| .. hint:: Use :c:func:`proc_create`. For the mode parameter, use 0, | |||
| and for the parent parameter use NULL. Use | |||
| :c:func:`my_proc_file_ops` for operations. | |||
| :c:data:`struct file_operations my_proc_file_ops` for operations. | |||
There was a problem hiding this comment.
Hmm, this does not seem like it is rendering properly:
I think the correct fix is ":c:data:`my_proc_file_ops`". In this case we can even drop the :c:func: part since we are only use this to create cross-references to kernel API documentation which is not the case here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
So it doesn't render as
my_proc_file_ops