Azure / Azure/azure-sdk-for-python

[docs] Fix broken systemperf install path in perfstress_tests.md

Open
#48,699 0 comments 0 reactions 0 assignees View on GitHub
agentic-workflows automated documentation
Dominant language
Python
Stars
5.6k
Forks
3.4k
Avg merge
1d 21h
Merged PRs (30d)
193

Description

## Summary

Reviewed all 55 markdown files under `doc/` for inconsistencies with the current source code and repository structure. One broken path was found and fixed.

## Change

**File:** `doc/dev/perfstress_tests.md`

**Before:**
```
pip install -e azure-sdk-for-python/tools/devtools_testutils[systemperf]
```

**After:**
```
pip install -e azure-sdk-for-python/eng/tools/azure-sdk-tools[systemperf]
```

**Why:** The `devtools_testutils` package was relocated from `tools/devtools_testutils/` to `eng/tools/azure-sdk-tools/`. The old path no longer exists in the repository, so anyone following this instruction would get a "no such file or directory" error. The `systemperf` optional dependency is defined in `eng/tools/azure-sdk-tools/pyproject.toml`, confirming the correct path.

## Other files checked (no changes needed)

- **`tox` references:** None found — docs already use `azpysdk` throughout.
- **`setup.py` references:** All contextually appropriate — appear only in legacy-package notes alongside `pyproject.toml` as the modern alternative.
- **Broken internal links:** None — all image and `.md` cross-references resolve correctly.
- **Contradictions between docs:** None found.
- **Stale package/path references:** Only the one fixed above.

> Generated by [Documentation Consistency Check](https://github.com/Azure/azure-sdk-for-python/actions/runs/32691838976) · 122.4 AIC · ⌖ 11.9 AIC · ⊞ 5.8K · [◷](https://github.com/search?q=repo%3AAzure%2Fazure-sdk-for-python+%22gh-aw-workflow-id%3A+doc-consistency-check%22&type=pullrequests)

---

> [!NOTE]
> This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
> The changes have been pushed to branch `docs/fix-perfstress-install-path-201f0f86227b27d5`.
>
> **[Click here to create the pull request](https://github.com/Azure/azure-sdk-for-python/compare/main...docs/fix-perfstress-install-path-201f0f86227b27d5?expand=1&title=%5Bdocs%5D%20Fix%20broken%20systemperf%20install%20path%20in%20perfstress_tests.md)**

To fix the permissions issue, go to **Settings** → **Actions** → **General** and enable **Allow GitHub Actions to create and approve pull requests**. See also: [gh-aw FAQ](https://github.github.com/gh-aw/reference/faq/#why-is-my-create-pull-request-workflow-failing-with-github-actions-is-not-permitted-to-create-or-approve-pull-requests)

Show patch (30 lines)

```diff
From afafceb3699f15ce7cf8248fcee9753b936554c3 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
Date: Mon, 24 Aug 2026 05:03:18 +0000
Subject: [PATCH] Fix broken install path in perfstress_tests.md

Update systemperf extra install path from tools/devtools_testutils to
eng/tools/azure-sdk-tools, which is the current location of the package.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
doc/dev/perfstress_tests.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/dev/perfstress_tests.md b/doc/dev/perfstress_tests.md
index c0f7fa85..fe3ded40 100644
--- a/doc/dev/perfstress_tests.md
+++ b/doc/dev/perfstress_tests.md
@@ -486,7 +486,7 @@ If your tests are not being discovered, run the `perfstressdebug` command instea
The system tests are used to test the performance of the Python HTTP layers exclusive of the Azure SDK in order to set a performance benchmark.
In order to run these, you will need a Python environment with `systemperf` flavour of `devtools_testutils` installed. Installing to a fresh Python environment is recommended.
```cmd
-(env) ~/> pip install -e azure-sdk-for-python/tools/devtools_testutils[systemperf]
+(env) ~/> pip install -e azure-sdk-for-python/eng/tools/azure-sdk-tools[systemperf]
```
Once these dependencies are installed, the `systemperf` command can be run directly to list the available tests:
```cmd
--
2.54.0

```

Contributor guide

Open the contributing guide

Research direction

Open doc/dev/perfstress_tests.md and compare the systemperf install command with the package location in eng/tools/azure-sdk-tools/pyproject.toml. Verify that the documented path matches the repository structure and that the systemperf command can be run after installation. Done means the obsolete tools/devtools_testutils path is no longer documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.