NetBSD Problem Report #53934

From www@NetBSD.org  Sun Feb  3 03:13:39 2019
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [199.233.217.200])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(Client CN "mail.NetBSD.org", Issuer "mail.NetBSD.org CA" (not verified))
	by mollari.NetBSD.org (Postfix) with ESMTPS id C60617A1C7
	for <gnats-bugs@gnats.NetBSD.org>; Sun,  3 Feb 2019 03:13:38 +0000 (UTC)
Message-Id: <20190203031337.D95B77A1F7@mollari.NetBSD.org>
Date: Sun,  3 Feb 2019 03:13:37 +0000 (UTC)
From: bapabooiee@gmail.com
Reply-To: bapabooiee@gmail.com
To: gnats-bugs@NetBSD.org
Subject: shells/fish could use a `doc' option to make building documentation with doxygen optional
X-Send-Pr-Version: www-1.0

>Number:         53934
>Category:       pkg
>Synopsis:       shells/fish could use a `doc' option to make building documentation with doxygen optional
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    leot
>State:          closed
>Class:          sw-bug
>Submitter-Id:   net
>Arrival-Date:   Sun Feb 03 03:15:00 +0000 2019
>Closed-Date:    Mon Feb 25 02:56:38 +0000 2019
>Last-Modified:  Mon Feb 25 02:56:38 +0000 2019
>Originator:     Dean Matzkov
>Release:        pkgsrc-2018Q4 and trunk
>Organization:
>Environment:
>Description:
Right now shells/fish requires devel/doxygen as a BUILD_DEPEND, and thus pulls in a lot of other dependencies (e.g. perl, python, graphviz, ghostscript, etc.) that all take quite a while to build, especially on slower platform. And from my experiences, these dependencies tend to hit build errors on other platforms such as Linux or macOS.

It'd be nice if there was a `doc' flag to make pulling-in doxygen and friends optional, since most users probably don't want to wait for all of that stuff when they just want to start using their preferred shell.

Thanks!
>How-To-Repeat:

>Fix:

>Release-Note:

>Audit-Trail:
From: Leonardo Taccari <leot@NetBSD.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: pkg/53934: shells/fish could use a `doc' option to make building documentation with doxygen optional
Date: Mon, 04 Feb 2019 21:19:49 +0100

 Hello Dean,

 bapabooiee@gmail.com writes:
 > [...]
 > >Description:
 > Right now shells/fish requires devel/doxygen as a BUILD_DEPEND, and thus=
  pulls in a lot of other dependencies (e.g. perl, python, graphviz, ghosts=
 cript, etc.) that all take quite a while to build, especially on slower pl=
 atform. And from my experiences, these dependencies tend to hit build erro=
 rs on other platforms such as Linux or macOS.
 >
 > It'd be nice if there was a `doc' flag to make pulling-in doxygen and fr=
 iends optional, since most users probably don't want to wait for all of th=
 at stuff when they just want to start using their preferred shell.
 > [...]

 Would you like to work at it? :)

 I think that a lot of inspiration can be taken, for example, by
 looking at devel/cppunit:

  - Create an options.mk (probably the one from cppunit can be just
    copypasted except for needing an adjustment in PKG_OPTIONS_VAR and
    maybe in CONFIGURE_ARGS!)
    According a `cvs log' it seems that doxygen was required on
    purpose so it is probably better to add the `doc' option to
    PKG_SUGGESTED_OPTIONS.
  - Add `.include "options.mk"' in Makefile and remove the
    `BUILD_DEPENDS+=3Ddoxygen-[0-9]*:../../devel/doxygen' line there.
  - Try to rebuild it and install with
    `env PKG_OPTIONS.fish=3D-doc make install', if everything worked there
    will be probably a big PLIST mismatch!  For all the mismatched
    entries please add a leading `${PLIST.doc}' line.


 Thank you!

From: Kamil Rytarowski <n54@gmx.com>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: pkg/53934: shells/fish could use a `doc' option to make building
 documentation with doxygen optional
Date: Mon, 4 Feb 2019 21:42:20 +0100

 On 04.02.2019 21:25, Leonardo Taccari wrote:
 > The following reply was made to PR pkg/53934; it has been noted by GNATS.
 > 
 > From: Leonardo Taccari <leot@NetBSD.org>
 > To: gnats-bugs@NetBSD.org
 > Cc: 
 > Subject: Re: pkg/53934: shells/fish could use a `doc' option to make building documentation with doxygen optional
 > Date: Mon, 04 Feb 2019 21:19:49 +0100
 > 
 >  Hello Dean,
 >  
 >  bapabooiee@gmail.com writes:
 >  > [...]
 >  > >Description:
 >  > Right now shells/fish requires devel/doxygen as a BUILD_DEPEND, and thus=
 >   pulls in a lot of other dependencies (e.g. perl, python, graphviz, ghosts=
 >  cript, etc.) that all take quite a while to build, especially on slower pl=
 >  atform. And from my experiences, these dependencies tend to hit build erro=
 >  rs on other platforms such as Linux or macOS.
 >  >
 >  > It'd be nice if there was a `doc' flag to make pulling-in doxygen and fr=
 >  iends optional, since most users probably don't want to wait for all of th=
 >  at stuff when they just want to start using their preferred shell.
 >  > [...]
 >  
 >  Would you like to work at it? :)
 >  
 >  I think that a lot of inspiration can be taken, for example, by
 >  looking at devel/cppunit:
 >  
 >   - Create an options.mk (probably the one from cppunit can be just
 >     copypasted except for needing an adjustment in PKG_OPTIONS_VAR and
 >     maybe in CONFIGURE_ARGS!)
 >     According a `cvs log' it seems that doxygen was required on
 >     purpose so it is probably better to add the `doc' option to
 >     PKG_SUGGESTED_OPTIONS.
 >   - Add `.include "options.mk"' in Makefile and remove the
 >     `BUILD_DEPENDS+=3Ddoxygen-[0-9]*:../../devel/doxygen' line there.
 >   - Try to rebuild it and install with
 >     `env PKG_OPTIONS.fish=3D-doc make install', if everything worked there
 >     will be probably a big PLIST mismatch!  For all the mismatched
 >     entries please add a leading `${PLIST.doc}' line.
 >  
 >  
 >  Thank you!
 >  
 > 

 I propose to split the package into fish and fish-doc. This way it will
 be more usable in binary prebuilt packages.

Responsible-Changed-From-To: pkg-manager->leot
Responsible-Changed-By: leot@NetBSD.org
Responsible-Changed-When: Mon, 04 Feb 2019 20:54:57 +0000
Responsible-Changed-Why:
Make myself responsable for possible help/updates.

(Dean, of course, do not hesitate to contact me also off-list
if any possible help is needed!)


From: Leonardo Taccari <leot@NetBSD.org>
To: gnats-bugs@NetBSD.org
Cc: 
Subject: Re: pkg/53934: shells/fish could use a `doc' option to make building documentation with doxygen optional
Date: Mon, 04 Feb 2019 21:50:06 +0100

 Hello Kamil,

 Kamil Rytarowski writes:
 > I propose to split the package into fish and fish-doc. This way it will
 > be more usable in binary prebuilt packages.

 IMHO this will just add more maintainer burden will little/no
 benefit.

 Binary package users already benefit from having the doc (and
 according the commit message this is also the rationale <maya>
 added an unconditional build dependency to doxygen) and not needing to
 have doxygen.

From: "Maya Rashish" <maya@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/53934 CVS commit: pkgsrc/shells/fish
Date: Tue, 12 Feb 2019 16:49:31 +0000

 Module Name:	pkgsrc
 Committed By:	maya
 Date:		Tue Feb 12 16:49:31 UTC 2019

 Modified Files:
 	pkgsrc/shells/fish: Makefile PLIST distinfo
 	pkgsrc/shells/fish/patches: patch-Makefile.in patch-src_fallback.cpp
 	    patch-src_output.cpp patch-src_output.h patch-src_screen.cpp
 Added Files:
 	pkgsrc/shells/fish: options.mk
 	pkgsrc/shells/fish/patches: patch-src_wutil.cpp

 Log Message:
 fish: update to 3.0.0

 Add a "doc" option, default on, to avoid a doxygen dependency.
 requested by martin & also in PR pkg/53934.

 # fish 3.0.0 (released December 28, 2018)

 fish 3 is a major release, which introduces some breaking changes alongside improved functionality. Although most existing scripts will continue to work, they should be reviewed against the list contained in the 3.0b1 release notes below.

 Compared to the beta release of fish 3.0b1, fish version 3.0.0:

 - builds correctly against musl libc (#5407)
 - handles huge numeric arguments to `test` correctly (#5414)
 - removes the history colouring introduced in 3.0b1, which did not always work correctly

 There is one significant known issue which was not able to be corrected before the release:

 - fish 3.0.0 builds on Cygwin (#5423), but does not run correctly (#5426) and will result in a hanging terminal when started. Cygwin users are encouraged to continue using 2.7.1 until a release which corrects this is available.

 If you are upgrading from version 2.7.1 or before, please also review the release notes for 3.0b1 (included below).

 ---

 # fish 3.0b1 (released December 11, 2018)

 fish 3 is a major release, which introduces some breaking changes alongside improved functionality. Although most existing scripts will continue to work, they should be reviewed against the list below.

 ## Notable non-backward compatible changes
 -  Process and job expansion has largely been removed. `%` will no longer perform these expansions, except for `%self` for the PID of the current shell. Additionally, job management commands (`disown`, `wait`, `bg`, `fg` and `kill`) will expand job specifiers starting with `%` (#4230, #1202).
 - `set x[1] x[2] a b`, to set multiple elements of an array at once, is no longer valid syntax (#4236).
 - A literal `{}` now expands to itself, rather than nothing. This makes working with `find -exec` easier (#1109, #4632).
 - Literally accessing a zero-index is now illegal syntax and is caught by the parser (#4862). (fish indices start at 1)
 - Successive commas in brace expansions are handled in less surprising manner. For example, `{,,,}` expands to four empty strings rather than an empty string, a comma and an empty string again (#3002, #4632).
 - `for` loop control variables are no longer local to the `for` block (#1935).
 - Variables set in `if` and `while` conditions are available outside the block (#4820).
 - Local exported (`set -lx`) vars are now visible to functions (#1091).
 - The new `math` builtin (see below) does not support logical expressions; `test` should be used instead (#4777).
 - Range expansion will now behave sensibly when given a single positive and negative index (`$foo[5..-1]` or `$foo[-1..5]`), clamping to the last valid index without changing direction if the list has fewer elements than expected.
 - `read` now uses `-s` as short for `--silent` (à la `bash`); `--shell`'s abbreviation (formerly `-s`) is now `-S` instead (#4490).
 - `cd` no longer resolves symlinks. fish now maintains a virtual path, matching other shells (#3350).
 - `source` now requires an explicit `-` as the filename to read from the terminal (#2633).
 - Arguments to `end` are now errors, instead of being silently ignored.
 - The names `argparse`, `read`, `set`, `status`, `test` and `[` are now reserved and not allowed as function names. This prevents users unintentionally breaking stuff (#3000).
 - The `fish_user_abbreviations` variable is no longer used; abbreviations will be migrated to the new storage format automatically.
 - The `FISH_READ_BYTE_LIMIT` variable is now called `fish_byte_limit` (#4414).
 - Environment variables are no longer split into arrays based on the record separator character on startup. Instead, variables are not split, unless their name ends in PATH, in which case they are split on colons (#436).
 - The `history` builtin's `--with-time` option has been removed; this has been deprecated in favor of `--show-time` since 2.7.0 (#4403).
 - The internal variables `__fish_datadir` and `__fish_sysconfdir` are now known as `__fish_data_dir` and `__fish_sysconf_dir` respectively.

 ## Deprecations

 With the release of fish 3, a number of features have been marked for removal in the future. All users are encouraged to explore alternatives. A small number of these features are currently behind feature flags, which are turned on at present but may be turned off by default in the future.

 A new feature flags mechanism is added for staging deprecations and breaking changes. Feature flags may be specified at launch with `fish --features ...` or by setting the universal `fish_features` variable. (#4940)

 - The use of the `IFS` variable for `read` is deprecated; `IFS` will be ignored in the future (#4156). Use the `read --delimiter` option instead.
 - The `function --on-process-exit` switch will be removed in future (#4700). Use the `fish_exit` event instead: `function --on-event fish_exit`.
 - `$_` is deprecated and will removed in the future (#813). Use `status current-command` in a command substitution instead.
 - `^` as a redirection deprecated and will be removed in the future. (#4394). Use `2>` to redirect stderr. This is controlled by the `stderr-nocaret` feature flag.
 - `?` as a glob (wildcard) is deprecated and will be removed in the future (#4520). This is controlled by the `qmark-noglob` feature flag.

 ## Notable fixes and improvements
 ### Syntax changes and new commands
 - fish now supports `&&` (like `and`), `||` (like `or`), and `!` (like `not`), for better migration from POSIX-compliant shells (#4620).
 - Variables may be used as commands (#154).
 - fish may be started in private mode via `fish --private`. Private mode fish sessions do not have access to the history file and any commands evaluated in private mode are not persisted for future sessions. A session variable `$fish_private_mode` can be queried to detect private mode and adjust the behavior of scripts accordingly to respect the user's wish for privacy.
 - A new `wait` command for waiting on backgrounded processes (#4498).
 - `math` is now a builtin rather than a wrapper around `bc` (#3157). Floating point computations is now used by default, and can be controlled with the new `--scale` option (#4478).
 - Setting `$PATH` no longer warns on non-existent directories, allowing for a single $PATH to be shared across machines (eg via dotfiles) (#2969).
 - `while` sets `$status` to a non-zero value if the loop is not executed (#4982).
 - Command substitution output is now limited to 10 MB by default, controlled by the `fish_read_limit` variable (#3822). Notably, this is larger than most operating systems' argument size limit, so trying to pass argument lists this size to external commands has never worked.
 - The machine hostname, where available, is now exposed as the `$hostname` reserved variable. This removes the dependency on the `hostname` executable (#4422).
 - Bare `bind` invocations in config.fish now work. The `fish_user_key_bindings` function is no longer necessary, but will still be executed if it exists (#5191).
 - `$fish_pid` and `$last_pid` are available as replacements for `%self` and `%last`.

 ### New features in commands
 - `alias` has a new `--save` option to save the generated function immediately (#4878).
 - `bind` has a new `--silent` option to ignore bind requests for named keys not available under the current terminal (#4188, #4431).
 - `complete` has a new `--keep-order` option to show the provided or dynamically-generated argument list in the same order as specified, rather than alphabetically (#361).
 - `exec` prompts for confirmation if background jobs are running.
 - `funced` has a new `--save` option to automatically save the edited function after successfully editing (#4668).
 - `functions` has a new ` --handlers` option to show functions registered as event handlers (#4694).
 - `history search` supports globs for wildcard searching (#3136) and has a new `--reverse` option to show entries from oldest to newest (#4375).
 - `jobs` has a new `--quiet` option to silence the output.
 - `read` has a new `--delimiter` option for splitting input into arrays (#4256).
 - `read` writes directly to stdout if called without arguments (#4407).
 - `read` can now read individual lines into separate variables without consuming the input in its entirety via the new `/--line` option.
 - `set` has new `--append` and `--prepend` options (#1326).
 - `set` has a new `--show` option to show lots of information about variables (#4265).
 - `string match` with an empty pattern and `--entire` in glob mode now matches everything instead of nothing (#4971).
 - `string split` supports a new `--no-empty` option to exclude empty strings from the result (#4779).
 - `string` has new subcommands `split0` and `join0` for working with NUL-delimited output.
 - `string` no longer stops processing text after NUL characters (#4605)
 - `string escape` has a new `--style regex` option for escaping strings to be matched literally in `string` regex operations.
 - `test` now supports floating point values in numeric comparisons.

 ### Interactive improvements
 - A pipe at the end of a line now allows the job to continue on the next line (#1285).
 - Italics and dim support out of the box on macOS for Terminal.app and iTerm (#4436).
 - `cd` tab completions no longer descend into the deepest unambiguous path (#4649).
 - Pager navigation has been improved. Most notably, moving down now wraps around, moving up from the commandline now jumps to the last element and moving right and left now reverse each other even when wrapping around (#4680).
 - Typing normal characters while the completion pager is active no longer shows the search field. Instead it enters them into the command line, and ends paging (#2249).
 - A new input binding `pager-toggle-search` toggles the search field in the completions pager on and off. By default, this is bound to Ctrl-S.
 - Searching in the pager now does a full fuzzy search (#5213).
 - The pager will now show the full command instead of just its last line if the number of completions is large (#4702).
 - Abbreviations can be tab-completed (#3233).
 - Tildes in file names are now properly escaped in completions (#2274).
 - Wrapping completions (from `complete --wraps` or `function --wraps`) can now inject arguments. For example, `complete gco --wraps 'git checkout'` now works properly (#1976). The `alias` function has been updated to respect this behavior.
 - Path completions now support expansions, meaning expressions like `python ~/<TAB>` now provides file suggestions just like any other relative or absolute path. (This includes support for other expansions, too.)
 - Autosuggestions try to avoid arguments that are already present in the command line.
 - Notifications about crashed processes are now always shown, even in command substitutions (#4962).
 - The screen is no longer reset after a BEL, fixing graphical glitches (#3693).
 - vi-mode now supports ';' and ',' motions. This introduces new {forward,backward}-jump-till and repeat-jump{,-reverse} bind functions (#5140).
 - The `*y` vi-mode binding now works (#5100).
 - True color is now enabled in neovim by default (#2792).
 - Terminal size variables (`$COLUMNS`/`$LINES`) are now updated before `fish_prompt` is called, allowing the prompt to react (#904).
 - Multi-line prompts no longer repeat when the terminal is resized (#2320).
 - `xclip` support has been added to the clipboard integration (#5020).
 - The Alt-P keybinding paginates the last command if the command line is empty.
 - `$cmd_duration` is no longer reset when no command is executed (#5011).
 - Deleting a one-character word no longer erases the next word as well (#4747).
 - Token history search (Alt-Up) omits duplicate entries (#4795).
 - The `fish_escape_delay_ms` timeout, allowing the use of the escape key both on its own and as part of a control sequence, was applied to all control characters; this has been reduced to just the escape key.
 - Completing a function shows the description properly (#5206).
 - Added completions for
   - `ansible`, including `ansible-galaxy`, `ansible-playbook` and `ansible-vault` (#4697)
   - `bb-power` (#4800)
   - `bd` (#4472)
   - `bower`
   - `clang` and `clang++` (#4174)
   - `conda` (#4837)
   - `configure` (for autoconf-generated files only)
   - `curl`
   - `doas` (#5196)
   - `ebuild` (#4911)
   - `emaint` (#4758)
   - `eopkg` (#4600)
   - `exercism` (#4495)
   - `hjson`
   - `hugo` (#4529)
   - `j` (from autojump #4344)
   - `jbake` (#4814)
   - `jhipster` (#4472)
   - `kitty`
   - `kldload`
   - `kldunload`
   - `makensis` (#5242)
   - `meson`
   - `mkdocs` (#4906)
   - `ngrok` (#4642)
   - OpenBSD's `pkg_add`, `pkg_delete`, `pkg_info`, `pfctl`, `rcctl`, `signify`, and `vmctl` (#4584)
   - `openocd`
   - `optipng`
   - `opkg` (#5168)
   - `pandoc` (#2937)
   - `port` (#4737)
   - `powerpill` (#4800)
   - `pstack` (#5135)
   - `serve` (#5026)
   - `ttx`
   - `unzip`
   - `virsh` (#5113)
   - `xclip` (#5126)
   - `xsv`
   - `zfs` and `zpool` (#4608)
 - Lots of improvements to completions (especially `darcs` (#5112), `git`, `hg` and `sudo`).
 - Completions for `yarn` and `npm` now require the `all-the-package-names` NPM package for full functionality.
 - Completions for `bower` and `yarn` now require the `jq` utility for full functionality.
 - Improved French translations.

 ### Other fixes and improvements
 - Significant performance improvements to `abbr` (#4048), setting variables (#4200, #4341), executing functions, globs (#4579), `string` reading from standard input (#4610), and slicing history (in particular, `$history[1]` for the last executed command).
 - Fish's internal wcwidth function has been updated to deal with newer Unicode, and the width of some characters can be configured via the `fish_ambiguous_width` (#5149) and `fish_emoji_width` (#2652) variables. Alternatively, a new build-time option INTERNAL_WCWIDTH can be used to use the system's wcwidth instead (#4816).
 - `functions` correctly supports `-d` as the short form of `--description`. (#5105)
 - `/etc/paths` is now parsed like macOS' bash `path_helper`, fixing $PATH order (#4336, #4852) on macOS.
 - Using a read-only variable in a `for` loop produces an error, rather than silently producing incorrect results (#4342).
 - The universal variables filename no longer contains the hostname or MAC address. It is now at the fixed location `.config/fish/fish_variables` (#1912).
 - Exported variables in the global or universal scope no longer have their exported status affected by local variables (#2611).
 - Major rework of terminal and job handling to eliminate bugs (#3805, #3952, #4178, #4235, #4238, #4540, #4929, #5210).
 - Improvements to the manual page completion generator (#2937, #4313).
 - `suspend --force` now works correctly (#4672).
 - Pressing Ctrl-C while running a script now reliably terminates fish (#5253).

 ### For distributors and developers
 - fish ships with a new build system based on CMake. CMake 3.2 is the minimum required version. Although the autotools-based Makefile and the Xcode project are still shipped with this release, they will be removed in the near future. All distributors and developers are encouraged to migrate to the CMake build.
 - Build scripts for most platforms no longer require bash, using the standard sh instead.
 - The `hostname` command is no longer required for fish to operate.


 To generate a diff of this commit:
 cvs rdiff -u -r1.17 -r1.18 pkgsrc/shells/fish/Makefile
 cvs rdiff -u -r1.6 -r1.7 pkgsrc/shells/fish/PLIST
 cvs rdiff -u -r1.12 -r1.13 pkgsrc/shells/fish/distinfo
 cvs rdiff -u -r0 -r1.1 pkgsrc/shells/fish/options.mk
 cvs rdiff -u -r1.3 -r1.4 pkgsrc/shells/fish/patches/patch-Makefile.in
 cvs rdiff -u -r1.1 -r1.2 pkgsrc/shells/fish/patches/patch-src_fallback.cpp
 cvs rdiff -u -r1.2 -r1.3 pkgsrc/shells/fish/patches/patch-src_output.cpp \
     pkgsrc/shells/fish/patches/patch-src_output.h \
     pkgsrc/shells/fish/patches/patch-src_screen.cpp
 cvs rdiff -u -r0 -r1.3 pkgsrc/shells/fish/patches/patch-src_wutil.cpp

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

State-Changed-From-To: open->closed
State-Changed-By: dholland@NetBSD.org
State-Changed-When: Mon, 25 Feb 2019 02:56:38 +0000
State-Changed-Why:
committed, thanks


>Unformatted:

Home	PR Database Search