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

[TASK] Unify confval names in ctrl section #982

Merged
merged 1 commit into from
Mar 26, 2024
Merged

[TASK] Unify confval names in ctrl section #982

merged 1 commit into from
Mar 26, 2024

Conversation

linawolf
Copy link
Member

@linawolf linawolf commented Mar 25, 2024

releases: main, 12.4, 11.5

depends on #981

@linawolf linawolf requested a review from brotkrueml March 25, 2024 18:05
Copy link
Contributor

@brotkrueml brotkrueml left a comment

Choose a reason for hiding this comment

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

Personally, I find the mix of lowercase (name, type) and uppercase (Path, Scope) irritating. Is there a rule?

@linawolf
Copy link
Member Author

yes: there are defined properties (type, name, noindex, .. those are in lowercase. All properties that are not predefined are used as labels and will be printed exactly the way they are written https://sphinx-toolbox.readthedocs.io/en/stable/extensions/confval.html

@linawolf linawolf merged commit 11c6e2f into main Mar 26, 2024
4 checks passed
@linawolf linawolf deleted the task/names1 branch March 26, 2024 13:08
Copy link
Contributor

The backport to 11.5 failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply 21e2e86... [TASK] Unify confval names in ctrl section
hint: After resolving the conflicts, mark them with
hint: "git add/rm <pathspec>", then run
hint: "git cherry-pick --continue".
hint: You can instead skip this commit with "git cherry-pick --skip".
hint: To abort and get back to the state before "git cherry-pick",
hint: run "git cherry-pick --abort".

stdout
Auto-merging Documentation/Ctrl/Properties/Enablecolumns.rst
Auto-merging Documentation/Ctrl/Properties/FormattedLabelUserFunc.rst
Auto-merging Documentation/Ctrl/Properties/Label.rst
CONFLICT (content): Merge conflict in Documentation/Ctrl/Properties/Label.rst
CONFLICT (modify/delete): Documentation/Ctrl/Properties/LabelAlt.rst deleted in HEAD and modified in 21e2e86 ([TASK] Unify confval names in ctrl section).  Version 21e2e86 ([TASK] Unify confval names in ctrl section) of Documentation/Ctrl/Properties/LabelAlt.rst left in tree.
CONFLICT (modify/delete): Documentation/Ctrl/Properties/LabelAltForce.rst deleted in HEAD and modified in 21e2e86 ([TASK] Unify confval names in ctrl section).  Version 21e2e86 ([TASK] Unify confval names in ctrl section) of Documentation/Ctrl/Properties/LabelAltForce.rst left in tree.
Auto-merging Documentation/Ctrl/Properties/ReadOnly.rst
CONFLICT (content): Merge conflict in Documentation/Ctrl/Properties/ReadOnly.rst
Auto-merging Documentation/Ctrl/Properties/RootLevel.rst
CONFLICT (content): Merge conflict in Documentation/Ctrl/Properties/RootLevel.rst
Auto-merging Documentation/Ctrl/Properties/SearchFields.rst
CONFLICT (content): Merge conflict in Documentation/Ctrl/Properties/SearchFields.rst
Auto-merging Documentation/Ctrl/Properties/Security.rst
Auto-merging Documentation/Ctrl/Properties/SeliconField.rst
Auto-merging Documentation/Ctrl/Properties/Type.rst
Auto-merging Documentation/Ctrl/Properties/TypeiconClasses.rst
Auto-merging Documentation/Ctrl/Properties/TypeiconColumn.rst

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-11.5 11.5
# Navigate to the new working tree
cd .worktrees/backport-11.5
# Create a new branch
git switch --create backport-982-to-11.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 21e2e86015153fa8a52e9d10196da4535ca86dda
# Push it to GitHub
git push --set-upstream origin backport-982-to-11.5
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-11.5

Then, create a pull request where the base branch is 11.5 and the compare/head branch is backport-982-to-11.5.

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

Successfully merging this pull request may close these issues.

2 participants