Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify the descritions of seq_file and flowchart #262

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

jouae
Copy link
Contributor

@jouae jouae commented Jul 2, 2024

7.4 The seq_file is missing the behavior that occurs when it directly returns NULL after the start step.

Also, in the flowchart, the first decision where return is NULL is Yes points to nothing, which is not defined in ISO 5807.

ISO 5807 section 10.3.1.2 states logic path of a decision, "Each exit from a symbol be accompanied by the appropriate condition values to show the logic path which it represents, so that the conditions and the associated references are identified."

The behavior of pointing to nothing does not have associated references and does not indicate the relation of this logic path.

Refs:
1. The Liunx Kernel Module Programming Guide 7.4 Manage /proc file with seq_file
2. ISO-5807-1985

7.4 The seq_file is missing the behavior that occurs when it
directly returns NULL after the start step.

Also, in the flowchart, the first decision where `return is NULL`
is `Yes` points to nothing, which is not defined in ISO 5807.

ISO 5807 section 10.3.1.2 states logic path of a decision,
"Each exit from a symbol be accompanied by the appropriate
condition values to show the logic path which it represents,
so that the conditions and the associated references are identified."

The behavior of pointing to nothing does not have associated
references and does not indicate the relation of this logic path.

Refs:
	1. The Liunx Kernel Module Programming Guide
	   7.4 Manage /proc file with seq_file
	2. ISO-5807-1985
@jserv jserv merged commit 031b9d2 into sysprog21:master Jul 2, 2024
1 check passed
@jserv
Copy link
Contributor

jserv commented Jul 2, 2024

Thank @jouae for contributing!

@jouae
Copy link
Contributor Author

jouae commented Jul 3, 2024

I find a typo duplicated word "otherwise",

let me fix it when I get off work today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants