mirror of
https://github.com/pytorch/pytorch.git
synced 2025-10-20 12:54:11 +08:00
Summary: *Context:* https://github.com/pytorch/pytorch/issues/53406 added a lint for trailing whitespace at the ends of lines. However, in order to pass FB-internal lints, that PR also had to normalize the trailing newlines in four of the files it touched. This PR adds an OSS lint to normalize trailing newlines. The changes to the following files (made in 54847d0adb9be71be4979cead3d9d4c02160e4cd) are the only manually-written parts of this PR: - `.github/workflows/lint.yml` - `mypy-strict.ini` - `tools/README.md` - `tools/test/test_trailing_newlines.py` - `tools/trailing_newlines.py` I would have liked to make this just a shell one-liner like the other three similar lints, but nothing I could find quite fit the bill. Specifically, all the answers I tried from the following Stack Overflow questions were far too slow (at least a minute and a half to run on this entire repository): - [How to detect file ends in newline?](https://stackoverflow.com/q/38746) - [How do I find files that do not end with a newline/linefeed?](https://stackoverflow.com/q/4631068) - [How to list all files in the Git index without newline at end of file](https://stackoverflow.com/q/27624800) - [Linux - check if there is an empty line at the end of a file [duplicate]](https://stackoverflow.com/q/34943632) - [git ensure newline at end of each file](https://stackoverflow.com/q/57770972) To avoid giving false positives during the few days after this PR is merged, we should probably only merge it after https://github.com/pytorch/pytorch/issues/54967. Pull Request resolved: https://github.com/pytorch/pytorch/pull/54737 Test Plan: Running the shell script from the "Ensure correct trailing newlines" step in the `quick-checks` job of `.github/workflows/lint.yml` should print no output and exit in a fraction of a second with a status of 0. That was not the case prior to this PR, as shown by this failing GHA workflow run on an earlier draft of this PR: - https://github.com/pytorch/pytorch/runs/2197446987?check_suite_focus=true In contrast, this run (after correcting the trailing newlines in this PR) succeeded: - https://github.com/pytorch/pytorch/pull/54737/checks?check_run_id=2197553241 To unit-test `tools/trailing_newlines.py` itself (this is run as part of our "Test tools" GitHub Actions workflow): ``` python tools/test/test_trailing_newlines.py ``` Reviewed By: malfet Differential Revision: D27409736 Pulled By: samestep fbshipit-source-id: 46f565227046b39f68349bbd5633105b2d2e9b19
71 lines
2.3 KiB
CMake
71 lines
2.3 KiB
CMake
# ---[ glog
|
|
|
|
# We will try to use the config mode first, and then manual find.
|
|
find_package(glog CONFIG QUIET)
|
|
if(NOT TARGET glog::glog)
|
|
find_package(glog MODULE QUIET)
|
|
endif()
|
|
|
|
if(TARGET glog::glog)
|
|
message(STATUS "Caffe2: Found glog with new-style glog target.")
|
|
elseif(GLOG_FOUND)
|
|
message(
|
|
STATUS
|
|
"Caffe2: Found glog with old-style glog starget. Glog never shipped "
|
|
"old style glog targets, so somewhere in your cmake path there might "
|
|
"be a custom Findglog.cmake file that got triggered. We will make a "
|
|
"best effort to create the new style glog target for you.")
|
|
add_library(glog::glog UNKNOWN IMPORTED)
|
|
set_property(
|
|
TARGET glog::glog PROPERTY IMPORTED_LOCATION ${GLOG_LIBRARY})
|
|
set_property(
|
|
TARGET glog::glog PROPERTY INTERFACE_INCLUDE_DIRECTORIES
|
|
${GLOG_INCLUDE_DIR})
|
|
else()
|
|
message(STATUS "Caffe2: Cannot find glog automatically. Using legacy find.")
|
|
|
|
# - Try to find Glog
|
|
#
|
|
# The following variables are optionally searched for defaults
|
|
# GLOG_ROOT_DIR: Base directory where all GLOG components are found
|
|
#
|
|
# The following are set after configuration is done:
|
|
# GLOG_FOUND
|
|
# GLOG_INCLUDE_DIRS
|
|
# GLOG_LIBRARIES
|
|
# GLOG_LIBRARYRARY_DIRS
|
|
|
|
include(FindPackageHandleStandardArgs)
|
|
set(GLOG_ROOT_DIR "" CACHE PATH "Folder contains Google glog")
|
|
if(NOT WIN32)
|
|
find_path(GLOG_INCLUDE_DIR glog/logging.h
|
|
PATHS ${GLOG_ROOT_DIR})
|
|
endif()
|
|
|
|
find_library(GLOG_LIBRARY glog
|
|
PATHS ${GLOG_ROOT_DIR}
|
|
PATH_SUFFIXES lib lib64)
|
|
|
|
find_package_handle_standard_args(glog DEFAULT_MSG GLOG_INCLUDE_DIR GLOG_LIBRARY)
|
|
|
|
if(GLOG_FOUND)
|
|
message(STATUS
|
|
"Caffe2: Found glog (include: ${GLOG_INCLUDE_DIR}, "
|
|
"library: ${GLOG_LIBRARY})")
|
|
add_library(glog::glog UNKNOWN IMPORTED)
|
|
set_property(
|
|
TARGET glog::glog PROPERTY IMPORTED_LOCATION ${GLOG_LIBRARY})
|
|
set_property(
|
|
TARGET glog::glog PROPERTY INTERFACE_INCLUDE_DIRECTORIES
|
|
${GLOG_INCLUDE_DIR})
|
|
endif()
|
|
endif()
|
|
|
|
# After above, we should have the glog::glog target now.
|
|
if(NOT TARGET glog::glog)
|
|
message(WARNING
|
|
"Caffe2: glog cannot be found. Depending on whether you are building "
|
|
"Caffe2 or a Caffe2 dependent library, the next warning / error will "
|
|
"give you more info.")
|
|
endif()
|