Skip to content

HDDS-15451. Fix broken pip install syntax in TestTools.md - #10407

Merged
amaliujia merged 5 commits into
apache:masterfrom
amaliujia:doc_fix
Jun 3, 2026
Merged

HDDS-15451. Fix broken pip install syntax in TestTools.md#10407
amaliujia merged 5 commits into
apache:masterfrom
amaliujia:doc_fix

Conversation

@amaliujia

@amaliujiaamaliujia commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

What changes were proposed in this pull request?

Summary

Fix broken pip install syntax in Blockade testing docs

Description

The Blockade section in hadoop-hdds/docs/content/tools/TestTools.md shows an invalid pip install command:

pip install pytest==2.8.7,blockade

The comma makes pip treat pytest==2.8.7,blockade as a single package name, so the command fails for anyone following the docs.

Fix: use space-separated package names:

pip install pytest==2.8.7 blockade

What is the link to the Apache JIRA

HDDS-15451

How was this patch tested?

Tested by hugo serve.

Screenshot 2026-06-02 at 12 44 00

@amaliujiaamaliujia changed the title Fix broken pip install syntax in documentationHDFS-xxxx: Fix broken pip install syntax in documentationJun 2, 2026
@amaliujiaamaliujia changed the title HDFS-xxxx: Fix broken pip install syntax in documentationHDFS-xxxx: Fix Broken pip install syntax in DocumentationJun 2, 2026
@amaliujiaamaliujia changed the title HDFS-xxxx: Fix Broken pip install syntax in DocumentationHDFS-xxxx: fix Broken pip install syntax in DocumentationJun 2, 2026
@amaliujiaamaliujia changed the title HDFS-xxxx: fix Broken pip install syntax in DocumentationHDDS-xxxx: fix Broken pip install syntax in DocumentationJun 2, 2026
@sreejasahithi

sreejasahithi commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

@amaliujia could you please create a jira for this PR and mention the jira ID in the PR title as well as in the commit message.

Example: #7806

@amaliujiaamaliujia changed the title HDDS-xxxx: fix Broken pip install syntax in DocumentationHDDS-15451: fix Broken pip install syntax in DocumentationJun 2, 2026
@amaliujiaamaliujia changed the title HDDS-15451: fix Broken pip install syntax in DocumentationHDDS-15451: fix broken pip install syntax in TestTools.mdJun 2, 2026
@amaliujia

Copy link
Copy Markdown
ContributorAuthor

@sreejasahithi thank you and done.

@amaliujiaamaliujia changed the title HDDS-15451: fix broken pip install syntax in TestTools.mdHDDS-15451. fix broken pip install syntax in TestTools.mdJun 2, 2026
@amaliujiaamaliujia changed the title HDDS-15451. fix broken pip install syntax in TestTools.mdHDDS-15451. Fix broken pip install syntax in TestTools.mdJun 2, 2026

@adoroszlaiadoroszlai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @amaliujia for checking these docs.

@@ -60,7 +60,7 @@ Blockade tests are implemented with the help of tests and can be started from th

```
cd blockade

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's in tests/blockade.

# fault injection tests
run cp -r "${ROOT}/hadoop-ozone/fault-injection-test/network-tests/src/test/blockade" tests

Suggested change
cd blockade
cd tests/blockade

Also appears in the sentence above:

Blockade tests are implemented with the help of tests and can be started from the `./blockade` directory of the distribution.

Also please consider improving that sentence, I don't think "Blockade tests are implemented with the help of tests" is meaningful.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comments addressed.

@sreejasahithisreejasahithi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @amaliujia for the patch, found some more corrections that can be done in this doc

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: every is repeated twice here

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch. Did a simple correction.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can just say ozone freon --help

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion applied

@sreejasahithisreejasahithi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@amaliujia
amaliujia merged commit c4c7c6f into apache:masterJun 3, 2026
18 checks passed
@amaliujiaamaliujia added the documentation Improvements or additions to documentation label Jun 3, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@amaliujia@sreejasahithi@adoroszlai