[clang-tools-extra] r230014 - Deleted module-map-checker, as it's been folded into modularize.

Sean Silva chisophugis at gmail.com
Fri Feb 20 17:04:53 PST 2015


In the future please do this in the same commit where they are moved to
their new place. We should never have dead or duplicated code in the tree.
More importantly, doing it in the same commit allows version control
systems to indicate that they were moved, so that it is obvious to a
reviewer precisely what is being moved, from where, to where, and in what
way the moved thing is (hopefully just slightly) different. Without this,
there is really no way to review such changes.

Thankfully in git I can just create a local branch and squash the two
commits together, but that is a huge pain.

One quick review comment: Please do not delete documentation pages; it
creates dead links across the net. Until we have a way on the server to
serve an HTTP redirect, please change the document to just be a single link
to the new home for that document, with an explanation. E.g. "module map
checker has been merged into modularize <link to modularize>"

-- Sean Silva

On Fri, Feb 20, 2015 at 6:28 AM, John Thompson <
John.Thompson.JTSoftware at gmail.com> wrote:

> Author: jtsoftware
> Date: Fri Feb 20 08:28:10 2015
> New Revision: 230014
>
> URL: http://llvm.org/viewvc/llvm-project?rev=230014&view=rev
> Log:
> Deleted module-map-checker, as it's been folded into modularize.
>
> Removed:
>     clang-tools-extra/trunk/docs/module-map-checker.rst
>     clang-tools-extra/trunk/module-map-checker/
>     clang-tools-extra/trunk/test/module-map-checker/
> Modified:
>     clang-tools-extra/trunk/CMakeLists.txt
>     clang-tools-extra/trunk/Makefile
>     clang-tools-extra/trunk/docs/index.rst
>     clang-tools-extra/trunk/test/CMakeLists.txt
>
> Modified: clang-tools-extra/trunk/CMakeLists.txt
> URL:
> http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/CMakeLists.txt?rev=230014&r1=230013&r2=230014&view=diff
>
> ==============================================================================
> --- clang-tools-extra/trunk/CMakeLists.txt (original)
> +++ clang-tools-extra/trunk/CMakeLists.txt Fri Feb 20 08:28:10 2015
> @@ -2,7 +2,6 @@ add_subdirectory(clang-apply-replacement
>  add_subdirectory(clang-modernize)
>  add_subdirectory(clang-rename)
>  add_subdirectory(modularize)
> -add_subdirectory(module-map-checker)
>  add_subdirectory(remove-cstr-calls)
>  if(CLANG_ENABLE_STATIC_ANALYZER)
>  add_subdirectory(clang-tidy)
>
> Modified: clang-tools-extra/trunk/Makefile
> URL:
> http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/Makefile?rev=230014&r1=230013&r2=230014&view=diff
>
> ==============================================================================
> --- clang-tools-extra/trunk/Makefile (original)
> +++ clang-tools-extra/trunk/Makefile Fri Feb 20 08:28:10 2015
> @@ -12,7 +12,7 @@ CLANG_LEVEL := ../..
>  include $(CLANG_LEVEL)/../../Makefile.config
>
>  PARALLEL_DIRS := remove-cstr-calls tool-template modularize \
> - module-map-checker pp-trace
> + pp-trace
>  DIRS := clang-apply-replacements clang-modernize clang-rename clang-tidy \
>         clang-query unittests
>
>
> Modified: clang-tools-extra/trunk/docs/index.rst
> URL:
> http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/index.rst?rev=230014&r1=230013&r2=230014&view=diff
>
> ==============================================================================
> --- clang-tools-extra/trunk/docs/index.rst (original)
> +++ clang-tools-extra/trunk/docs/index.rst Fri Feb 20 08:28:10 2015
> @@ -18,7 +18,6 @@ Contents
>     clang-modernize
>     clang-tidy
>     modularize
> -   module-map-checker
>     pp-trace
>
>
>
> Removed: clang-tools-extra/trunk/docs/module-map-checker.rst
> URL:
> http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/module-map-checker.rst?rev=230013&view=auto
>
> ==============================================================================
> --- clang-tools-extra/trunk/docs/module-map-checker.rst (original)
> +++ clang-tools-extra/trunk/docs/module-map-checker.rst (removed)
> @@ -1,88 +0,0 @@
> -.. index:: module-map-checker
> -
> -================================
> -Module-Map-Checker User's Manual
> -================================
> -
> -:program:`module-map-checker` is a tool that validates a module map by
> -checking that all headers in the corresponding directories are accounted
> for.
> -
> -This program uses the Clang ModuleMap class to read and parse the module
> -map file.  Starting at the module map file directory, or just the include
> -paths, if specified, it will collect the names of all the files it
> -considers headers.  It then compares the headers against those referenced
> -in the module map, either explicitly named, or implicitly named via an
> -umbrella directory or umbrella file, as parsed by the ModuleMap object.
> -If headers are found which are not referenced or covered by an umbrella
> -directory or file, warning messages will be produced, and this program
> -will return an error code of 1.  Other errors result in an error code of
> 2.
> -If no problems are found, an error code of 0 is returned.
> -
> -Note that in the case of umbrella headers, this tool invokes the compiler
> -to preprocess the file, and uses a callback to collect the header files
> -included by the umbrella header or any of its nested includes.  If any
> -front end options are needed for these compiler invocations, these
> -can be included on the command line after the module map file argument.
> -
> -Warning message have the form::
> -
> -  warning: module.modulemap does not account for file: header.h
> -
> -Note that for the case of the module map referencing a file that does
> -not exist, the module map parser in Clang will display an error message.
> -
> -Getting Started
> -===============
> -
> -To build from source:
> -
> -1. Read `Getting Started with the LLVM System`_ and `Clang Tools
> -   Documentation`_ for information on getting sources for LLVM, Clang, and
> -   Clang Extra Tools.
> -
> -2. `Getting Started with the LLVM System`_ and `Building LLVM with
> CMake`_ give
> -   directions for how to build. With sources all checked out into the
> -   right place the LLVM build will build Clang Extra Tools and their
> -   dependencies automatically.
> -
> -   * If using CMake, you can also use the ``module-map-checker`` target
> to build
> -     just the module-map-checker tool and its dependencies.
> -
> -.. _Getting Started with the LLVM System:
> http://llvm.org/docs/GettingStarted.html
> -.. _Building LLVM with CMake: http://llvm.org/docs/CMake.html
> -.. _Clang Tools Documentation: http://clang.llvm.org/docs/ClangTools.html
> -
> -Module-Map-Checker Usage
> -========================
> -
> -``module-map-checker [<module-map-checker-options>] <module-map-file>
> [<front-end-options>...]``
> -
> -``<module-map-checker-options>`` is a place-holder for options
> -specific to module-map-checker, which are described below in
> -`Module-Map-Checker Command Line Options`.
> -
> -``<module-map-file>`` specifies the path of a module map
> -file.  The path can be relative to the current directory.
> -
> -``<front-end-options>`` is a place-holder for regular Clang
> -front-end arguments, which must follow the <module-map-file>.
> -
> -Module-Map-Checker Command Line Options
> -=======================================
> -
> -.. option:: -I (include path)
> -
> -  Look at headers only in this directory tree.
> -  Must be a path relative to the module.modulemap file.
> -  There can be multiple ``-I`` options, for when the
> -  module map covers multiple directories, and
> -  excludes higher or sibling directories not
> -  specified. If this option is omitted, the
> -  directory containing the module-map-file is
> -  the root of the header tree to be searched for
> -  headers.
> -
> -.. option:: -dump-module-map
> -
> -  Dump the module map object during the check.
> -  This displays the modules and headers.
>
> Modified: clang-tools-extra/trunk/test/CMakeLists.txt
> URL:
> http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/test/CMakeLists.txt?rev=230014&r1=230013&r2=230014&view=diff
>
> ==============================================================================
> --- clang-tools-extra/trunk/test/CMakeLists.txt (original)
> +++ clang-tools-extra/trunk/test/CMakeLists.txt Fri Feb 20 08:28:10 2015
> @@ -41,7 +41,6 @@ set(CLANG_TOOLS_TEST_DEPS
>    clang-query
>    clang-tidy
>    modularize
> -  module-map-checker
>    pp-trace
>    remove-cstr-calls
>
>
>
> _______________________________________________
> cfe-commits mailing list
> cfe-commits at cs.uiuc.edu
> http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20150220/81c8a888/attachment.html>


More information about the cfe-commits mailing list