[all-commits] [llvm/llvm-project] 5a77b9: [NFC] Improve doc string to mention that paths in ...

[Christopher Tetreault via All-commits]

  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: 5a77b958e250fbf156474b42ccf5a82e8a36db72
      https://github.com/llvm/llvm-project/commit/5a77b958e250fbf156474b42ccf5a82e8a36db72
  Author: Christopher Tetreault <ctetreau at quicinc.com>
  Date:   2020-05-06 (Wed, 06 May 2020)

  Changed paths:
    M clang/tools/clang-format/clang-format-diff.py

  Log Message:
  -----------
  [NFC] Improve doc string to mention that paths in diff are used as-is

Summary:
Add --relative to the suggested git-diff one liner. If the user does not
pass this argument, then git will produce a diff with the path relative
to the repository root. If the user's working directory is not the
repository root, then clang-format will complain that the file is not
found. The --relative argument makes git produce a diff with the files
relative to the working directory.

Add note to doc string to warn users about the fact that filenames
embedded in the diff are used as-is with no attempts to "do what they
mean, not what they say"

Reviewers: djasper, alexfh, efriedma, klimek, thakis

Reviewed By: efriedma

Subscribers: cfe-commits

Tags: #clang

Differential Revision: https://reviews.llvm.org/D79054