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

Remove deprecated function "encodeWithUTF8()" #862

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove deprecated function "encodeWithUTF8()" #862

wants to merge 1 commit into from

Conversation

catpicture
Copy link

@catpicture catpicture commented Feb 2, 2021

The function encodeWithUTF8() no longer has reference after d38208a, which introduced decode_path() to replace encodeWithUTF8() for path encoding handling. I cannot think of a reason to keep encodeWithUTF8() in the codebase.

@gitgitgadget
Copy link

gitgitgadget bot commented Feb 2, 2021

Welcome to GitGitGadget

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

Please make sure that your Pull Request has a good description, as it will be used as cover letter.

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 "commit:", 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:

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

An alternative is the channel #git-devel on the FreeNode 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.

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 git-mentoring@googlegroups.com, 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 Freenode. 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 gitgitgadget bot added the new user label Feb 2, 2021
@gitgitgadget
Copy link

gitgitgadget bot commented Feb 2, 2021

There is an issue in commit 56929b5:
Commit not signed off

@dscho
Copy link
Member

dscho commented Feb 2, 2021

/allow

@dscho
Copy link
Member

dscho commented Feb 2, 2021

@feiyeung please wrap the commit message, add your Signed-off-by: trailer, and prefix the commit message with p4: to let casual readers know what area the patch touches. Thanks!

@gitgitgadget
Copy link

gitgitgadget bot commented Feb 2, 2021

User feiyeung is now allowed to use GitGitGadget.

WARNING: feiyeung has no public email address set on GitHub

@gitgitgadget
Copy link

gitgitgadget bot commented Feb 3, 2021

There is an issue in commit a080a23:
Prefixed commit message must be in lower case: git-p4: Remove deprecated function "encodeWithUTF8()"

@catpicture
Copy link
Author

@feiyeung please wrap the commit message, add your Signed-off-by: trailer, and prefix the commit message with p4: to let casual readers know what area the patch touches. Thanks!

Thanks for the instructions; i have the commit message updated.

(First time attempt to contribute to a large open source project, i'm kinda lost on what to do)

commit d38208a introduced function "decode_path()" to replace "encodeWithUTF8()". This old function "encodeWithUTF8()" no longer has reference by any code in this file.

Signed-off-by: Feiynag Xue <fxue@roku.com>
@dscho
Copy link
Member

dscho commented Feb 3, 2021

Looks good! Feel free to /submit.

@catpicture
Copy link
Author

/submit

@gitgitgadget
Copy link

gitgitgadget bot commented Feb 3, 2021

Submitted as pull.862.git.1612371471347.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git pr-862/feiyeung/remove-encodeWithUTF8-v1

To fetch this version to local tag pr-862/feiyeung/remove-encodeWithUTF8-v1:

git fetch --no-tags https://github.com/gitgitgadget/git tag pr-862/feiyeung/remove-encodeWithUTF8-v1

@gitgitgadget
Copy link

gitgitgadget bot commented Feb 3, 2021

On the Git mailing list, Junio C Hamano wrote (reply to this):

"Feiyang via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Feiynag Xue <fxue@roku.com>
>
> commit d38208a297e76bbfbfa8e485632c217aaafa9486 introduced function "decode_path()" to replace "encodeWithUTF8()". This old function "encodeWithUTF8()" no longer has reference by any code in this file.
>
> Signed-off-by: Feiynag Xue <fxue@roku.com>

 - Please line-wrap your log message to reasonable length, like around
   70 columns.

 - We refer to an existing commit like this: d38208a2 (git-p4:
   convert path to unicode before processing them, 2019-12-13)

   You can ask "git show -s --pretty=reference d38208a2" to produce
   such a string with versions of Git that are recent enough (like
   v2.25 or newer), or --pretty='format:%h (%s, %ad)' can be used
   instead of --pretty=reference for older version of Git.

 - Please Cc: those who are likely to know the area to ask for their
   reviews.  This patch addresses a fallout from an existing commit,
   and its author would be a good candidate.

 - "deprecated" is probably not the word you wanted to use here, as
   it has a connotation that something was suboptimal with it, and
   it got replaced by something else.  Reading your description, I
   think you are removing a function that is no longer used.

   I'd suggest rewriting it to something like:

     Subject: git-p4: remove "encodeWithUTF8()" that is no longer used

     d38208a2 (git-p4: convert path to unicode before processing
     them, 2019-12-13) introduced the function "decode_path()" to
     replace the "encodeWithUTF8()" method of P4Sync class, which no
     longer is used anywhere.

     Remove it.

Thanks.

>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-862%2Ffeiyeung%2Fremove-encodeWithUTF8-v1
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-862/feiyeung/remove-encodeWithUTF8-v1
> Pull-Request: https://github.com/gitgitgadget/git/pull/862
>
>  git-p4.py | 12 ------------
>  1 file changed, 12 deletions(-)
>
> diff --git a/git-p4.py b/git-p4.py
> index 09c9e93ac40..2c7e5498afa 100755
> --- a/git-p4.py
> +++ b/git-p4.py
> @@ -2939,18 +2939,6 @@ def writeToGitStream(self, gitMode, relPath, contents):
>              self.gitStream.write(d)
>          self.gitStream.write('\n')
>  
> -    def encodeWithUTF8(self, path):
> -        try:
> -            path.decode('ascii')
> -        except:
> -            encoding = 'utf8'
> -            if gitConfig('git-p4.pathEncoding'):
> -                encoding = gitConfig('git-p4.pathEncoding')
> -            path = path.decode(encoding, 'replace').encode('utf8', 'replace')
> -            if self.verbose:
> -                print('Path with non-ASCII characters detected. Used %s to encode: %s ' % (encoding, path))
> -        return path
> -
>      # output one file from the P4 stream
>      # - helper for streamP4Files
>  
>
> base-commit: e6362826a0409539642a5738db61827e5978e2e4

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

Successfully merging this pull request may close these issues.

None yet

2 participants