Hi Klemens,

the authors of this tool absolutely do not understand how documentation
works.  That said, i agree it is better to install whatever piss-poor
and disorganized musings they do provide rather than installing no
documentation whatsoever.

See below in-line for two questions, none of which are intended to
oppose or even delay your commit.

Yours,
  Ingo


Klemens Nanni wrote on Mon, Jun 10, 2019 at 10:34:21PM +0200:

> Index: Makefile
> ===================================================================
> RCS file: /cvs/ports/devel/include-what-you-use/Makefile,v
> retrieving revision 1.15
> diff -u -p -r1.15 Makefile
> --- Makefile  16 Feb 2019 12:06:23 -0000      1.15
> +++ Makefile  10 Jun 2019 20:33:34 -0000
> @@ -3,28 +3,40 @@
>  COMMENT=     tool to analyse \#includes in C and C++ source files
>  CATEGORIES=  devel
>  DISTNAME=    include-what-you-use-0.11.src
> -PKGNAME=     include-what-you-use-0.11
> -REVISION=    0
> +PKGNAME=     ${DISTNAME:.src=}
> +REVISION=    1
>  
> -HOMEPAGE=    http://include-what-you-use.org
> +HOMEPAGE=    https://include-what-you-use.org
>  MASTER_SITES=        ${HOMEPAGE}/downloads/
>  WRKDIST=     ${WRKDIR}/include-what-you-use
>  
>  MAINTAINER=  Jonathan Gray <j...@openbsd.org>
>  
>  # BSD
> -PERMIT_PACKAGE_CDROM=        Yes
> +PERMIT_PACKAGE=      Yes
>  
> -WANTLIB=     c curses execinfo form m pthread z
> +WANTLIB=     ${COMPILER_LIBCXX} c execinfo m pthread
>  LLVM_V=              7.0.1
>  BUILD_DEPENDS=       devel/llvm>=${LLVM_V}
>  RUN_DEPENDS= devel/llvm>=${LLVM_V}

Why does this have an unconditional dependency on ports LLVM?
For example, on amd64, it actually uses base LLVM unless i read
the build logs incorrectly.

I realize this is unrelated to your changes, just wondering...

Uh oh...  Then again, is see stuff like

  CMAKE_CXX_COMPILER_AR:FILEPATH=/usr/local/bin/llvm-ar
  CMAKE_CXX_COMPILER_RANLIB:FILEPATH=/usr/local/bin/llvm-ranlib
  CMAKE_C_COMPILER_AR:FILEPATH=/usr/local/bin/llvm-ar
  CMAKE_C_COMPILER_RANLIB:FILEPATH=/usr/local/bin/llvm-ranlib
  CMAKE_LINKER:FILEPATH=/usr/bin/ld
  CMAKE_RANLIB:FILEPATH=/usr/bin/ranlib
  Clang_DIR:PATH=/usr/local/lib/cmake/clang
  LLVM_DIR:PATH=/usr/local/lib/cmake/llvm

in CMakeCache.txt - mixing toolchains like this makes me feel uneasy,
even if both clangs currently happen to be 7.0.1 on amd64.
Is this really safe, even if the two should occasionally diverge,
which they sometimes do according to what i have seen in the past?

>  LIB_DEPENDS= devel/libexecinfo
>  
>  MODULES=             devel/cmake lang/python
> +MODPY_BUILDDEP=              No
> +MODPY_VERSION=               ${MODPY_DEFAULT_VERSION_3}
> +MODPY_ADJ_FILES=     *.py
> +
>  COMPILER=            base-clang ports-gcc
>  COMPILER_LANGS=              c++
>  
> -MODPY_ADJ_FILES = fix_includes.py iwyu_tool.py
> +DOCDIR=                      ${PREFIX}/share/doc/include-what-you-use
> +
> +do-test:
> +     cd ${WRKSRC} && ./run_iwyu_tests.py
> +
> +post-install:
> +     ${INSTALL_DATA_DIR} ${DOCDIR}/
> +     ${INSTALL_DATA} ${WRKSRC}/docs/* ${DOCDIR}/
> +     ${INSTALL_DATA} ${WRKSRC}/README.md 
> ${PREFIX}/share/include-what-you-use/

It feels like you install README.md to the wrong place.
Can you install it to /usr/local/share/doc/include-what-you-use/
instead, together with the other "documentation"?

Yes, the file is a total mess in so far as it mixes build instructions
(which shouldn't be installed at all) with usage instructions - which
ought to be in a section 1 manual page, include-what-you-use(1).  But
given that it does contain some usage instructions, even though well
hidden among a lot of crap and very imprecise, i think it does
belong in ${DOCDIR}/.

Reply via email to