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

[BUGFIX] Fix reference syntax #319

Merged
merged 1 commit into from
Feb 18, 2024
Merged

[BUGFIX] Fix reference syntax #319

merged 1 commit into from
Feb 18, 2024

Conversation

linawolf
Copy link
Member

No description provided.

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.

Is the space mandatory now or just a visual thing?

@linawolf
Copy link
Member Author

The reST Syntax asks for the space. However Spinx interprets references without the space correctly and does not throw warnings.

the phpdocumentor/guides currently do not interpret such references correctly. But as it is a common mistake and worked until now I made a PR to also allow it in the guides: phpDocumentor/guides#851

@linawolf linawolf merged commit 8f7cae3 into main Feb 18, 2024
2 checks passed
@linawolf linawolf deleted the bugfix/references branch February 18, 2024 06:37
Copy link
Contributor

The backport to 11.5 failed:

The process '/usr/bin/git' failed with exit code 1
stderr
error: could not apply 62dabf5... [BUGFIX] Fix reference syntax
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/Extensions/Index.rst
CONFLICT (modify/delete): Documentation/Localization.ru_RU/Extensions/Index.rst deleted in HEAD and modified in 62dabf5 ([BUGFIX] Fix reference syntax).  Version 62dabf5 ([BUGFIX] Fix reference syntax) of Documentation/Localization.ru_RU/Extensions/Index.rst left in tree.
CONFLICT (modify/delete): Documentation/Localization.ru_RU/Setup/Index.rst deleted in HEAD and modified in 62dabf5 ([BUGFIX] Fix reference syntax).  Version 62dabf5 ([BUGFIX] Fix reference syntax) of Documentation/Localization.ru_RU/Setup/Index.rst left in tree.
Auto-merging Documentation/UserManagement/GroupPermissions/Index.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-319-to-11.5
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick 62dabf5005645b9fafbac535471a7d0daa8f39b0
# Push it to GitHub
git push --set-upstream origin backport-319-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-319-to-11.5.

linawolf added a commit that referenced this pull request Feb 18, 2024
(cherry picked from commit 8f7cae3)
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