AcademySoftwareFoundation / AcademySoftwareFoundation/rez

Improve documentation of rez-context --diff

Open
#506 2 comments 0 reactions 0 assignees View on GitHub
documentation rez-context
Dominant language
Python
Stars
1.1k
Forks
369
Avg merge
12d 3h
Merged PRs (30d)
5

Description

rez-context is super useful to diff rez resolves, but it assumes you're already in one of the rez-created environments to diff.
`rez-context --diff` needs a secondary form which allows you to diff two contexts while not in an existing resolve.
For example: `rez-context --diff /path/to/oldcontext.rxt /path/to/newcontext.rxt`

Contributor guide

Open the contributing guide

Research direction

Start at the rez-context CLI entry point and trace the existing --diff handling, especially its requirement for an active Rez-created environment. Done means `rez-context --diff /path/to/oldcontext.rxt /path/to/newcontext.rxt` can compare two context files without an existing resolve; add or update the relevant CLI tests if present.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.