Fix git-p4 decode_path() missing an assignment

[SaNeOr]

When using git-p4 in the python2 environment, some places decode( ) missing an assignment.

cc: Patrick Steinhardt [email protected]

[gitgitgadget-git]

Welcome to GitGitGadget

Hi @SaNeOr, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that either:

• Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
• Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <[email protected]>, Ill Takalook <[email protected]>

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

• the lines should not exceed 76 columns,
• the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
• the commit messages' body should be describing the "why?" of the change.
• Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

• Search: is:pr is:open "/allow"

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join [email protected], where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

[gitgitgadget-git]

There are issues in commit 982f74f:
Fix git-p4 decode_path() missing an assignment
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget-git]

There are issues in commit 4d292ed:
Fix git-p4 decode_path() missing an assignment
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget-git]

There are issues in commit a63bfd7:
Fix git-p4 decode_path() missing an assignment
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget-git]

There are issues in commit b1f8fe2:
Fix git-p4 decode_path() missing an assignment
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget-git]

There are issues in commit baca5bd:
Fix git-p4 decode() missing an assignment
Commit checks stopped - the message is too short
Commit not signed off

[gitgitgadget-git]

There are issues in commit 8d4077b:
Fix git-p4 decode() missing an assignment
Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
Indented lines, and lines without whitespace, are exempt

[dscho]

/allow

[gitgitgadget-git]

User SaNeOr is now allowed to use GitGitGadget.

[SaNeOr]

/preview

[gitgitgadget-git]

Error: Could not determine full name of SaNeOr

[gitgitgadget-git]

Error: Could not determine full name of SaNeOr

[SaNeOr]

/preview

[gitgitgadget-git]

Preview email sent as [email protected]

[SaNeOr]

/submit

[gitgitgadget-git]

Submitted as [email protected]

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-1683/SaNeOr/master-v1

To fetch this version to local tag pr-git-1683/SaNeOr/master-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-1683/SaNeOr/master-v1

[gitgitgadget-git]

On the Git mailing list, Patrick Steinhardt wrote (reply to this):

On Mon, Mar 04, 2024 at 08:54:15AM +0000, W Sero via GitGitGadget wrote:
> From: SaNeOr <[email protected]>
> 
> bugfix: When using git-p4 in the python2 environment,
> some places decode() missing an assignment.
> 
> Signed-off-by: W Sero <[email protected]>
> ---
>     Fix git-p4 decode_path() missing an assignment
>     
>     When using git-p4 in the python2 environment, some places decode( )
>     missing an assignment.
> 
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1683%2FSaNeOr%2Fmaster-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1683/SaNeOr/master-v1
> Pull-Request: https://github.com/git/git/pull/1683
> 
>  git-p4.py | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/git-p4.py b/git-p4.py
> index 28ab12c72b6..9fa4b9b104e 100755
> --- a/git-p4.py
> +++ b/git-p4.py
> @@ -307,7 +307,7 @@ def decode_path(path):
>          return path.decode(encoding, errors='replace') if isinstance(path, bytes) else path
>      else:
>          try:
> -            path.decode('ascii')
> +            path = path.decode('ascii')

Is this fixing an actual bug that you have encountered? I'm mostly
asking because I think this actually works as inteded: we only try to
decode the path using the specified encoding in case where it is not
representable as ASCII. If it contained e.g. Unicode characters, then
this statement here would throw and we end up decoding in the `except`
branch. Otherwise, we know that the path only contains ASCII characters
and thus we don't have to change it in the first place.

Whether that complexity is sensible might be a different question. But
it at least shouldn't result in any user visible bug, no?

Patrick

>          except:
>              path = path.decode(encoding, errors='replace')
>              if verbose:
> @@ -3114,7 +3114,7 @@ def writeToGitStream(self, gitMode, relPath, contents):
>  
>      def encodeWithUTF8(self, path):
>          try:
> -            path.decode('ascii')
> +            path = path.decode('ascii')
>          except:
>              encoding = 'utf8'
>              if gitConfig('git-p4.pathEncoding'):
> 
> base-commit: 0f9d4d28b7e6021b7e6db192b7bf47bd3a0d0d1d
> -- 
> gitgitgadget
> 

[gitgitgadget-git]

User Patrick Steinhardt <[email protected]> has been added to the cc: list.