Skip to content

Document tree handling and workdirs#4704

Merged
psss merged 7 commits intomainfrom
psss-glossary-trees
Mar 20, 2026
Merged

Document tree handling and workdirs#4704
psss merged 7 commits intomainfrom
psss-glossary-trees

Conversation

@psss
Copy link
Member

@psss psss commented Mar 16, 2026

Define user tree, work tree and test tree.
Document run workdir and plan workdir as well.
Add the Tree Handling section for contributors.

Fix #4663.

Pull Request Checklist

  • write the documentation
  • include a release note

@psss psss added the documentation Improvements or additions to documentation label Mar 16, 2026
@psss psss added this to planning Mar 16, 2026
@github-project-automation github-project-automation bot moved this to backlog in planning Mar 16, 2026
@psss psss added this to the 1.70 milestone Mar 16, 2026
@psss psss moved this from backlog to review in planning Mar 16, 2026
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request adds documentation for user tree, work tree, and test tree concepts. The review identifies several areas for improvement to enhance clarity and correctness. Key issues include inconsistent example paths, conversational phrasing that violates the style guide, and factual inaccuracies in the description of which tree is used at different stages of a tmt run. Applying the suggested changes will make the documentation more precise and easier for contributors to understand.

@mcasquer mcasquer self-assigned this Mar 17, 2026
@psss psss force-pushed the psss-glossary-trees branch from 81d0b4d to ac7d917 Compare March 17, 2026 08:57
@psss psss requested a review from mcasquer March 17, 2026 09:08
Copy link
Contributor

@mcasquer mcasquer left a comment

Choose a reason for hiding this comment

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

LGTM

@psss psss force-pushed the psss-glossary-trees branch from 8fbcc3c to 02ffd28 Compare March 18, 2026 09:13
@psss psss requested a review from happz March 18, 2026 09:28
@psss psss force-pushed the psss-glossary-trees branch from 2e2bd44 to cf6e1c6 Compare March 19, 2026 06:44
@LecrisUT LecrisUT moved this from review to merge in planning Mar 19, 2026
psss added 4 commits March 20, 2026 09:35
Define `user tree`, `work tree` and `test tree`.
Document `run workdir` and `plan workdir` as well.
Add the `Tree Handling` section for contributors.

Fix #4663.
@psss psss force-pushed the psss-glossary-trees branch from cf6e1c6 to 984ea9d Compare March 20, 2026 08:35
@psss
Copy link
Member Author

psss commented Mar 20, 2026

Documentation change, core tests passed, merging.

@psss psss merged commit 187781f into main Mar 20, 2026
19 checks passed
@psss psss deleted the psss-glossary-trees branch March 20, 2026 09:03
@github-project-automation github-project-automation bot moved this from merge to done in planning Mar 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: done

Development

Successfully merging this pull request may close these issues.

Document user tree, work tree and test tree in the Glossary

4 participants