Fix documentation #3247

MarkGriffiths · 2016-07-16T10:39:36Z

Description

Restores erroneous changes to lexicon_filter and changes to doc_src/ pages. Done by hand to ensure version history. Original warnings about unsupported xml/html tags were caused by a missing \endfish in string.txt.
Fixes display of % when misinterpreted by Doxygen.
Updated Formatting.md, removing mention of now-removed developer docs. Will add content regarding escaping and troubleshooting from some of my recent comments in a subsequent PR.
No warnings produced during make; tested with Doxygen 1.8.7 and 1.8.11 on Ubuntu 14.04.4 LTS and macOS 10.11

Fixes issue #3197 and fish-shell/fish-site#40
Supersedes #3198

TODOs:

Changes to fish usage are reflected in user documenation/manpages.
~~Tests have been added for regressions fixed~~ n/a

Restores erroneous changes to lexicon_filter and changes to doc_src/ pages. Done by hand to ensure version history. Fixes display of % when misinterpreted by Doxygen.

Only found one instance, which I’d already identified.

floam · 2016-07-16T16:03:06Z

I'm still getting the warnings I mentioned encountering in #3198 with Doxygen HEAD.

I want to just escape whatever it mentions, wherever I find it... but I get nervous as I've messed that up before when the strings shouldn't have reached that stage of the process.

make doc (entire output below)

FISH_BUILD_VERSION = 2.3.1-392-g0513f63
rm command_list.tmp command_list_toc.tmp doc_src/commands.hdr
rm: command_list.tmp: No such file or directory
rm: command_list_toc.tmp: No such file or directory
rm: doc_src/commands.hdr: No such file or directory
make: [doc_src/commands.hdr] Error 1 (ignored)
for i in `printf "%s\n" doc_src/abbr.txt doc_src/alias.txt doc_src/and.txt doc_src/begin.txt doc_src/bg.txt doc_src/bind.txt doc_src/block.txt doc_src/break.txt doc_src/breakpoint.txt doc_src/builtin.txt doc_src/case.txt doc_src/cd.txt doc_src/command.txt doc_src/commandline.txt doc_src/complete.txt doc_src/contains.txt doc_src/continue.txt doc_src/count.txt doc_src/dirh.txt doc_src/dirs.txt doc_src/echo.txt doc_src/else.txt doc_src/emit.txt doc_src/end.txt doc_src/eval.txt doc_src/exec.txt doc_src/exit.txt doc_src/false.txt doc_src/fg.txt doc_src/fish.txt doc_src/fish_config.txt doc_src/fish_indent.txt doc_src/fish_key_reader.txt doc_src/fish_mode_prompt.txt doc_src/fish_prompt.txt doc_src/fish_realpath.txt doc_src/fish_right_prompt.txt doc_src/fish_update_completions.txt doc_src/fish_vi_mode.txt doc_src/for.txt doc_src/funced.txt doc_src/funcsave.txt doc_src/function.txt doc_src/functions.txt doc_src/help.txt doc_src/history.txt doc_src/if.txt doc_src/isatty.txt doc_src/jobs.txt doc_src/math.txt doc_src/nextd.txt doc_src/not.txt doc_src/open.txt doc_src/or.txt doc_src/popd.txt doc_src/prevd.txt doc_src/printf.txt doc_src/prompt_pwd.txt doc_src/psub.txt doc_src/pushd.txt doc_src/pwd.txt doc_src/random.txt doc_src/read.txt doc_src/return.txt doc_src/set.txt doc_src/set_color.txt doc_src/source.txt doc_src/status.txt doc_src/string.txt doc_src/suspend.txt doc_src/switch.txt doc_src/test.txt doc_src/trap.txt doc_src/true.txt doc_src/type.txt doc_src/ulimit.txt doc_src/umask.txt doc_src/vared.txt doc_src/while.txt|sort`; do \
        echo "<hr>" >>command_list.tmp; \
        cat $i >>command_list.tmp; \
        echo >>command_list.tmp; \
        echo >>command_list.tmp; \
        NAME=`basename $i .txt`; \
        echo '- <a href="#'$NAME'">'$NAME'</a>' >> command_list_toc.tmp; \
        echo "Back to <a href='index.html#toc-commands'>index</a>". >>command_list.tmp; \
    done
mv command_list.tmp command_list.txt
mv command_list_toc.tmp command_list_toc.txt
cat doc_src/commands.hdr.in | awk '{if ($0 ~ /@command_list_toc@/) { system("cat command_list_toc.txt"); } else if ($0 ~ /@command_list@/){ system("cat command_list.txt");} else{ print $0;}}' >doc_src/commands.hdr
rm toc.tmp toc.txt
rm: toc.tmp: No such file or directory
rm: toc.txt: No such file or directory
make: [toc.txt] Error 1 (ignored)
# Ugly hack to set the toc initial title for the main page
echo '- <a href="index.html" id="toc-index">Documentation</a>' > toc.tmp
# The first sed command captures the page name, followed by the description
# The second sed command captures the command name \1 and the description \2, but only up to a dash
# This is to reduce the size of the TOC in the command listing on the main page
for i in doc_src/index.hdr.in doc_src/tutorial.hdr doc_src/design.hdr doc_src/license.hdr doc_src/commands.hdr doc_src/faq.hdr; do\
        NAME=`basename $i .hdr`; \
        NAME=`basename $NAME .hdr.in`; \
        /usr/local/bin/gsed <$i >>toc.tmp -n \
        -e 's,.*\\page *\([^ ]*\) *\(.*\)$,- <a href="'$NAME'.html" id="toc-'$NAME'">\2</a>,p' \
        -e 's,.*\\section *\([^ ]*\) *\([^-]*\)\(.*\)$,  - <a href="'$NAME'.html#\1">\2</a>,p'; \
    done
mv toc.tmp toc.txt
cat doc_src/index.hdr.in | awk '{if ($0 ~ /@toc@/){ system("cat toc.txt");} else{ print $0;}}' >doc_src/index.hdr
cat doc_src/index.hdr doc_src/tutorial.hdr doc_src/design.hdr doc_src/license.hdr doc_src/commands.hdr doc_src/faq.hdr >doc.h
rm lexicon.tmp lexicon_catalog.tmp lexicon_catalog.txt lexicon.txt
rm: lexicon.tmp: No such file or directory
rm: lexicon_catalog.tmp: No such file or directory
rm: lexicon_catalog.txt: No such file or directory
rm: lexicon.txt: No such file or directory
make: [lexicon.txt] Error 1 (ignored)
# Scan sources for commands/functions/binaries/colours. If GNU sed was portable, this could be much smarter.
/usr/local/bin/gsed <command_list_toc.txt >>lexicon.tmp -n \
        -e "s|^.*>\([a-z][a-z_]*\)</a>|'\1'|w lexicon_catalog.tmp" \
        -e "s|'\(.*\)'|bltn \1|p"; mv lexicon_catalog.tmp lexicon_catalog.txt; \
    printf "%s\n" share/completions/a2disconf.fish share/completions/a2dismod.fish share/completions/a2dissite.fish share/completions/a2enconf.fish share/completions/a2enmod.fish share/completions/a2ensite.fish share/completions/abbr.fish share/completions/abook.fish share/completions/acat.fish share/completions/accept.fish share/completions/ack.fish share/completions/acpi.fish share/completions/adb.fish share/completions/adduser.fish share/completions/adiff.fish share/completions/als.fish share/completions/alsactl.fish share/completions/alsamixer.fish share/completions/amixer.fish share/completions/anamnesis.fish share/completions/and.fish share/completions/animate.fish share/completions/ant.fish share/completions/apack.fish share/completions/apm.fish share/completions/apropos.fish share/completions/apt-build.fish share/completions/apt-cache.fish share/completions/apt-cdrom.fish share/completions/apt-config.fish share/completions/apt-extracttemplates.fish share/completions/apt-file.fish share/completions/apt-ftparchive.fish share/completions/apt-get.fish share/completions/apt-key.fish share/completions/apt-listbugs.fish share/completions/apt-listchanges.fish share/completions/apt-mark.fish share/completions/apt-move.fish share/completions/apt-proxy-import.fish share/completions/apt-rdepends.fish share/completions/apt-setup.fish share/completions/apt-show-source.fish share/completions/apt-show-versions.fish share/completions/apt-sortpkgs.fish share/completions/apt-spy.fish share/completions/apt-src.fish share/completions/apt-zip-inst.fish share/completions/apt-zip-list.fish share/completions/apt.fish share/completions/aptitude.fish share/completions/arepack.fish share/completions/arp.fish share/completions/asp.fish share/completions/at.fish share/completions/atd.fish share/completions/atom.fish share/completions/atool.fish share/completions/atq.fish share/completions/atrm.fish share/completions/aunpack.fish share/completions/aura.fish share/completions/awk.fish share/completions/badblocks.fish share/completions/bc.fish share/completions/bg.fish share/completions/bind.fish share/completions/bison.fish share/completions/block.fish share/completions/break.fish share/completions/brew.fish share/completions/btdownloadcurses.py.fish share/completions/btdownloadheadless.py.fish share/completions/builtin.fish share/completions/bundle.fish share/completions/bunzip2.fish share/completions/burp.fish share/completions/busctl.fish share/completions/bzcat.fish share/completions/bzip2.fish share/completions/bzip2recover.fish share/completions/bzr.fish share/completions/cabal-dev.fish share/completions/cabal.fish share/completions/cancel.fish share/completions/canto.fish share/completions/cargo.fish share/completions/cat.fish share/completions/cd.fish share/completions/cdrecord.fish share/completions/chgrp.fish share/completions/chmod.fish share/completions/chown.fish share/completions/chsh.fish share/completions/colordiff.fish share/completions/colorsvn.fish share/completions/combine.fish share/completions/command.fish share/completions/commandline.fish share/completions/compare.fish share/completions/complete.fish share/completions/composer.fish share/completions/composer.phar.fish share/completions/composite.fish share/completions/configure.fish share/completions/conjure.fish share/completions/continue.fish share/completions/convert.fish share/completions/cower.fish share/completions/cowsay.fish share/completions/cowthink.fish share/completions/cp.fish share/completions/cupsaccept.fish share/completions/cupsdisable.fish share/completions/cupsenable.fish share/completions/cupsreject.fish share/completions/cut.fish share/completions/cvs.fish share/completions/cygport.fish share/completions/darcs.fish share/completions/date.fish share/completions/dcop.fish share/completions/dd.fish share/completions/df.fish share/completions/diff.fish share/completions/diskutil.fish share/completions/display.fish share/completions/djview.fish share/completions/djview3.fish share/completions/djview4.fish share/completions/dlocate.fish share/completions/dmesg.fish share/completions/dnf.fish share/completions/dpkg.fish share/completions/dropbox.fish share/completions/du.fish share/completions/duply.fish share/completions/dvipdf.fish share/completions/dvipdfm.fish share/completions/echo.fish share/completions/effectv.fish share/completions/egrep.fish share/completions/eix-sync.fish share/completions/eix.fish share/completions/elatex.fish share/completions/elixir.fish share/completions/emacs.fish share/completions/emerge.fish share/completions/encfs.fish share/completions/entr.fish share/completions/env.fish share/completions/equery.fish share/completions/eselect.fish share/completions/etex.fish share/completions/eval.fish share/completions/evince.fish share/completions/exec.fish share/completions/exit.fish share/completions/expand.fish share/completions/fcrontab.fish share/completions/fg.fish share/completions/fgrep.fish share/completions/file.fish share/completions/find.fish share/completions/fish.fish share/completions/fish_indent.fish share/completions/flac.fish share/completions/fluxbox-remote.fish share/completions/fossil.fish share/completions/ftp.fish share/completions/funced.fish share/completions/funcsave.fish share/completions/function.fish share/completions/functions.fish share/completions/fuser.fish share/completions/fusermount.fish share/completions/gcc.fish share/completions/gdb.fish share/completions/gem.fish share/completions/git.fish share/completions/go.fish share/completions/godoc.fish share/completions/gofmt.fish share/completions/goimports.fish share/completions/golint.fish share/completions/gorename.fish share/completions/gpasswd.fish share/completions/gpg.fish share/completions/gphoto2.fish share/completions/gprof.fish share/completions/grep.fish share/completions/groupadd.fish share/completions/grunt.fish share/completions/gunzip.fish share/completions/gv.fish share/completions/gvim.fish share/completions/gvimdiff.fish share/completions/gzip.fish share/completions/head.fish share/completions/help.fish share/completions/heroku.fish share/completions/hg.fish share/completions/highlight.fish share/completions/history.fish share/completions/htop.fish share/completions/iconv.fish share/completions/id.fish share/completions/identify.fish share/completions/iex.fish share/completions/ifconfig.fish share/completions/ifdata.fish share/completions/ifdown.fish share/completions/ifup.fish share/completions/import.fish share/completions/invoke-rc.d.fish share/completions/ip.fish share/completions/iptables.fish share/completions/jobs.fish share/completions/journalctl.fish share/completions/kcmshell5.fish share/completions/kill.fish share/completions/killall.fish share/completions/kitchen.fish share/completions/la.fish share/completions/latex.fish share/completions/latexmk.fish share/completions/lein.fish share/completions/less.fish share/completions/ll.fish share/completions/ln.fish share/completions/localectl.fish share/completions/locate.fish share/completions/logkeys.fish share/completions/lp.fish share/completions/lpadmin.fish share/completions/lpinfo.fish share/completions/lpmove.fish share/completions/lpoptions.fish share/completions/lppasswd.fish share/completions/lpq.fish share/completions/lpr.fish share/completions/lprm.fish share/completions/lpstat.fish share/completions/ls.fish share/completions/lsblk.fish share/completions/lscpu.fish share/completions/lsof.fish share/completions/lsusb.fish share/completions/lua.fish share/completions/lualatex.fish share/completions/lunchy.fish share/completions/lxpanel.fish share/completions/m4.fish share/completions/machinectl.fish share/completions/make.fish share/completions/makedepend.fish share/completions/makepkg.fish share/completions/man.fish share/completions/mc.fish share/completions/md5sum.fish share/completions/meat.fish share/completions/mix.fish share/completions/mkdir.fish share/completions/mkinitcpio.fish share/completions/mktemp.fish share/completions/mocp.fish share/completions/modinfo.fish share/completions/modprobe.fish share/completions/mogrify.fish share/completions/montage.fish share/completions/mosh.fish share/completions/mount.fish share/completions/mplayer.fish share/completions/msgfmt.fish share/completions/mupdf.fish share/completions/mutt.fish share/completions/mv.fish share/completions/mvn.fish share/completions/namei.fish share/completions/native2ascii.fish share/completions/ncdu.fish share/completions/netcat.fish share/completions/netctl-auto.fish share/completions/netctl.fish share/completions/networkctl.fish share/completions/nextd.fish share/completions/nice.fish share/completions/nl.fish share/completions/nm.fish share/completions/nmcli.fish share/completions/node.fish share/completions/not.fish share/completions/npm.fish share/completions/nvim.fish share/completions/obnam.fish share/completions/oggenc.fish share/completions/omega.fish share/completions/opam.fish share/completions/open.fish share/completions/or.fish share/completions/pacaur.fish share/completions/pacman-color.fish share/completions/pacman-key.fish share/completions/pacman.fish share/completions/pacmatic.fish share/completions/pacmd.fish share/completions/pacsrv.fish share/completions/pactl.fish share/completions/pactree.fish share/completions/patch.fish share/completions/pbget.fish share/completions/pdfelatex.fish share/completions/pdfetex.fish share/completions/pdflatex.fish share/completions/pdftex.fish share/completions/pdftotext.fish share/completions/perl.fish share/completions/pftp.fish share/completions/pgrep.fish share/completions/pine.fish share/completions/ping.fish share/completions/pinky.fish share/completions/pkg-config.fish share/completions/pkg.fish share/completions/pkgadd.fish share/completions/pkgfile.fish share/completions/pkginfo.fish share/completions/pkgmk.fish share/completions/pkgrm.fish share/completions/pkill.fish share/completions/poff.fish share/completions/pon.fish share/completions/portmaster.fish share/completions/ports.fish share/completions/poweroff.fish share/completions/prevd.fish share/completions/prt-get.fish share/completions/ps.fish share/completions/ps2pdf.fish share/completions/psql.fish share/completions/psub.fish share/completions/pushd.fish share/completions/pydf.fish share/completions/python.fish share/completions/python2.fish share/completions/python3.fish share/completions/quilt.fish share/completions/random.fish share/completions/rbenv.fish share/completions/rc-service.fish share/completions/rc-update.fish share/completions/rc.d.fish share/completions/read.fish share/completions/readlink.fish share/completions/realpath.fish share/completions/reject.fish share/completions/rejmerge.fish share/completions/renice.fish share/completions/return.fish share/completions/rfkill.fish share/completions/rgrep.fish share/completions/rm.fish share/completions/rmdir.fish share/completions/rmmod.fish share/completions/root.fish share/completions/rpm.fish share/completions/rsync.fish share/completions/ruby-build.fish share/completions/ruby.fish share/completions/rustc.fish share/completions/sass-convert.fish share/completions/sass.fish share/completions/scanimage.fish share/completions/scons.fish share/completions/scp.fish share/completions/screen.fish share/completions/scrot.fish share/completions/scss.fish share/completions/sed.fish share/completions/seq.fish share/completions/service.fish share/completions/set.fish share/completions/set_color.fish share/completions/setfacl.fish share/completions/setxkbmap.fish share/completions/sha1sum.fish share/completions/sha224sum.fish share/completions/sha256sum.fish share/completions/sha384sum.fish share/completions/sha512sum.fish share/completions/sort.fish share/completions/source.fish share/completions/ssh.fish share/completions/sshfs.fish share/completions/stack.fish share/completions/stat.fish share/completions/status.fish share/completions/stream.fish share/completions/string.fish share/completions/su.fish share/completions/sudo.fish share/completions/svn.fish share/completions/sylpheed.fish share/completions/sysctl.fish share/completions/systemctl.fish share/completions/systemd-analyze.fish share/completions/systemd-nspawn.fish share/completions/tail.fish share/completions/tar.fish share/completions/tee.fish share/completions/telnet.fish share/completions/termite.fish share/completions/test.fish share/completions/tex.fish share/completions/time.fish share/completions/timedatectl.fish share/completions/timeout.fish share/completions/tmux.fish share/completions/tmuxinator.fish share/completions/top.fish share/completions/totem.fish share/completions/touch.fish share/completions/tr.fish share/completions/transmission-remote.fish share/completions/trap.fish share/completions/travis.fish share/completions/tree.fish share/completions/type.fish share/completions/udisksctl.fish share/completions/ulimit.fish share/completions/umount.fish share/completions/uname.fish share/completions/unexpand.fish share/completions/uniq.fish share/completions/unrar.fish share/completions/update-eix-remote.fish share/completions/update-eix.fish share/completions/useradd.fish share/completions/vagrant.fish share/completions/valgrind.fish share/completions/vared.fish share/completions/vi.fish share/completions/vim-addons.fish share/completions/vim.fish share/completions/vimdiff.fish share/completions/w.fish share/completions/wajig.fish share/completions/watch.fish share/completions/wc.fish share/completions/wesnoth.fish share/completions/wget.fish share/completions/whatis.fish share/completions/which.fish share/completions/who.fish share/completions/wicd-cli.fish share/completions/wicd-client.fish share/completions/wicd-gtk.fish share/completions/wpa_cli.fish share/completions/wvdial.fish share/completions/xargs.fish share/completions/xdg-mime.fish share/completions/xdvi.fish share/completions/xelatex.fish share/completions/xgettext.fish share/completions/xmms.fish share/completions/xpdf.fish share/completions/xprop.fish share/completions/xrandr.fish share/completions/xrdb.fish share/completions/xsel.fish share/completions/xterm.fish share/completions/xz.fish share/completions/yaourt.fish share/completions/yast2.fish share/completions/yum.fish share/completions/zcat.fish share/completions/zip.fish share/completions/zypper.fish share/completions/..fish | /usr/local/bin/gsed -n \
        -e "s|[^ ]*/\([a-z][a-z_-]*\).fish|'\1'|p" | fgrep -vx -f lexicon_catalog.txt | /usr/local/bin/gsed >>lexicon.tmp -n \
        -e 'w lexicon_catalog.tmp' \
        -e "s|'\(.*\)'|cmnd \1|p"; cat lexicon_catalog.tmp >> lexicon_catalog.txt; \
    printf "%s\n" share/functions/N_.fish share/functions/_.fish share/functions/__fish_append.fish share/functions/__fish_bind_test1.fish share/functions/__fish_bind_test2.fish share/functions/__fish_cancel_commandline.fish share/functions/__fish_commandline_test.fish share/functions/__fish_complete_abook_formats.fish share/functions/__fish_complete_ant_targets.fish share/functions/__fish_complete_atool_archive_contents.fish share/functions/__fish_complete_bittorrent.fish share/functions/__fish_complete_blockdevice.fish share/functions/__fish_complete_cd.fish share/functions/__fish_complete_command.fish share/functions/__fish_complete_convert_options.fish share/functions/__fish_complete_directories.fish share/functions/__fish_complete_file_url.fish share/functions/__fish_complete_ftp.fish share/functions/__fish_complete_groups.fish share/functions/__fish_complete_job_pids.fish share/functions/__fish_complete_list.fish share/functions/__fish_complete_lpr.fish share/functions/__fish_complete_lpr_option.fish share/functions/__fish_complete_lsusb.fish share/functions/__fish_complete_man.fish share/functions/__fish_complete_path.fish share/functions/__fish_complete_pgrep.fish share/functions/__fish_complete_pids.fish share/functions/__fish_complete_ppp_peer.fish share/functions/__fish_complete_proc.fish share/functions/__fish_complete_setxkbmap.fish share/functions/__fish_complete_ssh.fish share/functions/__fish_complete_subcommand.fish share/functions/__fish_complete_subcommand_root.fish share/functions/__fish_complete_suffix.fish share/functions/__fish_complete_svn_diff.fish share/functions/__fish_complete_tar.fish share/functions/__fish_complete_unrar.fish share/functions/__fish_complete_users.fish share/functions/__fish_complete_wvdial_peers.fish share/functions/__fish_config_interactive.fish share/functions/__fish_contains_opt.fish share/functions/__fish_crux_packages.fish share/functions/__fish_cursor_konsole.fish share/functions/__fish_cursor_xterm.fish share/functions/__fish_describe_command.fish share/functions/__fish_filter_ant_targets.fish share/functions/__fish_git_prompt.fish share/functions/__fish_gnu_complete.fish share/functions/__fish_hg_prompt.fish share/functions/__fish_is_first_token.fish share/functions/__fish_is_token_n.fish share/functions/__fish_list_current_token.fish share/functions/__fish_make_completion_signals.fish share/functions/__fish_man_page.fish share/functions/__fish_move_last.fish share/functions/__fish_no_arguments.fish share/functions/__fish_not_contain_opt.fish share/functions/__fish_number_of_cmd_args_wo_opts.fish share/functions/__fish_paginate.fish share/functions/__fish_ports_dirs.fish share/functions/__fish_print_abook_emails.fish share/functions/__fish_print_addresses.fish share/functions/__fish_print_arch_daemons.fish share/functions/__fish_print_cmd_args.fish share/functions/__fish_print_cmd_args_without_options.fish share/functions/__fish_print_commands.fish share/functions/__fish_print_debian_apache_confs.fish share/functions/__fish_print_debian_apache_mods.fish share/functions/__fish_print_debian_apache_sites.fish share/functions/__fish_print_debian_services.fish share/functions/__fish_print_encodings.fish share/functions/__fish_print_filesystems.fish share/functions/__fish_print_function_prototypes.fish share/functions/__fish_print_help.fish share/functions/__fish_print_hostnames.fish share/functions/__fish_print_interfaces.fish share/functions/__fish_print_lpr_options.fish share/functions/__fish_print_lpr_printers.fish share/functions/__fish_print_lsblk_columns.fish share/functions/__fish_print_make_targets.fish share/functions/__fish_print_modules.fish share/functions/__fish_print_mounted.fish share/functions/__fish_print_packages.fish share/functions/__fish_print_pacman_repos.fish share/functions/__fish_print_service_names.fish share/functions/__fish_print_svn_rev.fish share/functions/__fish_print_users.fish share/functions/__fish_print_xdg_mimeapps.fish share/functions/__fish_print_xdg_mimetypes.fish share/functions/__fish_print_xrandr_modes.fish share/functions/__fish_print_xrandr_outputs.fish share/functions/__fish_print_xwindows.fish share/functions/__fish_prt_no_subcommand.fish share/functions/__fish_prt_packages.fish share/functions/__fish_prt_ports.fish share/functions/__fish_prt_use_package.fish share/functions/__fish_prt_use_port.fish share/functions/__fish_pwd.fish share/functions/__fish_seen_subcommand_from.fish share/functions/__fish_sgrep.fish share/functions/__fish_svn_prompt.fish share/functions/__fish_systemctl_automounts.fish share/functions/__fish_systemctl_devices.fish share/functions/__fish_systemctl_mounts.fish share/functions/__fish_systemctl_scopes.fish share/functions/__fish_systemctl_service_paths.fish share/functions/__fish_systemctl_services.fish share/functions/__fish_systemctl_slices.fish share/functions/__fish_systemctl_snapshots.fish share/functions/__fish_systemctl_sockets.fish share/functions/__fish_systemctl_swaps.fish share/functions/__fish_systemctl_targets.fish share/functions/__fish_systemctl_timers.fish share/functions/__fish_systemd_machine_images.fish share/functions/__fish_systemd_machines.fish share/functions/__fish_test_arg.fish share/functions/__fish_toggle_comment_commandline.fish share/functions/__fish_urlencode.fish share/functions/__fish_use_subcommand.fish share/functions/__fish_vcs_prompt.fish share/functions/__terlar_git_prompt.fish share/functions/abbr.fish share/functions/alias.fish share/functions/cd.fish share/functions/contains_seq.fish share/functions/delete-or-exit.fish share/functions/dirh.fish share/functions/dirs.fish share/functions/down-or-search.fish share/functions/eval.fish share/functions/export.fish share/functions/fish_clipboard_copy.fish share/functions/fish_clipboard_paste.fish share/functions/fish_config.fish share/functions/fish_default_key_bindings.fish share/functions/fish_fallback_prompt.fish share/functions/fish_indent.fish share/functions/fish_mode_prompt.fish share/functions/fish_prompt.fish share/functions/fish_update_completions.fish share/functions/fish_vi_cursor.fish share/functions/fish_vi_key_bindings.fish share/functions/fish_vi_mode.fish share/functions/funced.fish share/functions/funcsave.fish share/functions/grep.fish share/functions/help.fish share/functions/history.fish share/functions/hostname.fish share/functions/isatty.fish share/functions/la.fish share/functions/ll.fish share/functions/ls.fish share/functions/man.fish share/functions/math.fish share/functions/nextd-or-forward-word.fish share/functions/nextd.fish share/functions/open.fish share/functions/popd.fish share/functions/prevd-or-backward-word.fish share/functions/prevd.fish share/functions/prompt_pwd.fish share/functions/psub.fish share/functions/pushd.fish share/functions/realpath.fish share/functions/seq.fish share/functions/setenv.fish share/functions/string.fish share/functions/suspend.fish share/functions/trap.fish share/functions/type.fish share/functions/umask.fish share/functions/up-or-search.fish share/functions/vared.fish | /usr/local/bin/gsed -n \
        -e "s|[^ ]*/\([a-z][a-z_-]*\).fish|'\1'|p" | fgrep -vx -f lexicon_catalog.txt | /usr/local/bin/gsed >>lexicon.tmp -n \
        -e 'w lexicon_catalog.tmp' \
        -e "s|'\(.*\)'|func \1|p"; \
    /usr/local/bin/gsed <share/functions/__fish_config_interactive.fish >>lexicon.tmp -n \
        -e '/set_default/s/.*\(fish_[a-z][a-z_]*\).*$/clrv \1/p'; \
    /usr/local/bin/gsed <lexicon_filter.in >>lexicon.tmp -n \
        -e '/^#.!#/s/^#.!# \(.... [a-z][a-z_]*\)/\1/p'; \
    mv lexicon.tmp lexicon.txt; rm -f lexicon_catalog.tmp lexicon_catalog.txt;
rm lexicon_filter.tmp lexicon_filter
rm: lexicon_filter.tmp: No such file or directory
rm: lexicon_filter: No such file or directory
make: [lexicon_filter] Error 1 (ignored)
# Set the shebang as sed can reside in multiple places.
/usr/local/bin/gsed <lexicon_filter.in >lexicon_filter.tmp -e 's|@sed@|'/usr/local/bin/gsed'|'
# Scan through the lexicon, transforming each line to something useful to Doxygen.
if echo x | /usr/local/bin/gsed "/[[:<:]]x/d" 2>/dev/null; then \
        WORDBL='[[:<:]]'; WORDBR='[[:>:]]'; \
    else \
        WORDBL='\\<'; WORDBR='\\>'; \
    fi; \
    /usr/local/bin/gsed <lexicon.txt >>lexicon_filter.tmp -n \
        -e "s|^\([a-z][a-z][a-z][a-z]\) \([a-z_-]*\)$|s,$WORDBL\2$WORDBR,@\1{\2},g|p" \
        -e '$G;s/.*\n/b tidy/p'; \
    mv lexicon_filter.tmp lexicon_filter; if test -x lexicon_filter; then true; else chmod a+x lexicon_filter; fi
(cat Doxyfile.user; echo INPUT_FILTER=./lexicon_filter; \
    echo PROJECT_NUMBER=2.3.1-392-g0513f63 | /usr/local/bin/gsed "s/-.*//") | \
        doxygen - && touch user_doc; \
    cd user_doc/html && rm -f arrow*.png bc_s.png bdwn.png closed.png \
        doc.png folder*.png ftv2*.png nav*.png open.png splitbar.png \
        sync_*.png tab*.* doxygen.* dynsections.js jquery.js pages.html
Notice: Output directory `user_doc' does not exist. I have created it for you.
Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for msc files...
Searching for dia files...
Searching for files to exclude
Searching INPUT for files to process...
Searching for files in directory /Users/floam/src/githubfish
Reading and parsing tag files
Parsing files
Reading /Users/floam/src/githubfish/doc.h...
Parsing file /Users/floam/src/githubfish/doc.h...
Building group list...
Building directory list...
Building namespace list...
Building file list...
Building class list...
Associating documentation with classes...
Computing nesting relations for classes...
Building example list...
Searching for enumerations...
Searching for documented typedefs...
Searching for members imported via using declarations...
Searching for included using directives...
Searching for documented variables...
Building interface member list...
Building member list...
Searching for friends...
Searching for documented defines...
Computing class inheritance relations...
Computing class usage relations...
Flushing cached template relations that have become invalid...
Computing class relations...
Add enum values to enums...
Searching for member function documentation...
Creating members for template instances...
Building page list...
Search for main page...
Computing page relations...
Determining the scope of groups...
Sorting lists...
Freeing entry tree
Determining which enums are documented
Computing member relations...
Building full member lists recursively...
Adding members to member groups.
Computing member references...
Generating disk names...
Adding source references...
Adding xrefitems...
Sorting member lists...
Computing dependencies between directories...
Generating citations page...
Counting data structures...
Resolving user defined references...
Finding anchors and sections in the documentation...
Transferring function references...
Combining using relations...
Adding members to index pages...
Generating style sheet...
Generating search indices...
Generating example documentation...
Generating file sources...
Parsing code for file doc.h...
Generating file documentation...
Generating page documentation...
Generating docs for page tutorial...
Generating docs for page design...
Generating docs for page license...
Generating docs for page commands...
/Users/floam/src/githubfish/doc.h:2815: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:2815: warning: Found unknown command `\ew'
/Users/floam/src/githubfish/doc.h:2815: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:2815: warning: Found unknown command `\cx'
/Users/floam/src/githubfish/doc.h:3652: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:3654: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:3656: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:3658: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:3660: warning: Found unknown command `\f'
/Users/floam/src/githubfish/doc.h:3664: warning: Found unknown command `\r'
/Users/floam/src/githubfish/doc.h:3666: warning: Found unknown command `\t'
/Users/floam/src/githubfish/doc.h:3668: warning: Found unknown command `\v'
/Users/floam/src/githubfish/doc.h:3672: warning: Found unknown command `\xHH'
/Users/floam/src/githubfish/doc.h:4903: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:4904: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:4905: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:4906: warning: expected whitespace after tt command
/Users/floam/src/githubfish/doc.h:4907: warning: Found unknown command `\f'
/Users/floam/src/githubfish/doc.h:4909: warning: Found unknown command `\r'
/Users/floam/src/githubfish/doc.h:4910: warning: Found unknown command `\t'
/Users/floam/src/githubfish/doc.h:4911: warning: Found unknown command `\v'
/Users/floam/src/githubfish/doc.h:4912: warning: Found unknown command `\ooo'
/Users/floam/src/githubfish/doc.h:4913: warning: Found unknown command `\xhh'
/Users/floam/src/githubfish/doc.h:4914: warning: Found unknown command `\uhhhh'
/Users/floam/src/githubfish/doc.h:4915: warning: Found unknown command `\Uhhhhhhhh'
/Users/floam/src/githubfish/doc.h:5517: warning: Found unknown command `\t'
/Users/floam/src/githubfish/doc.h:6206: warning: end of comment block while expecting command </code>
Generating docs for page faq...
Generating group documentation...
Generating class documentation...
Generating namespace index...
Generating graph info page...
Generating directory documentation...
Generating index page...
/Users/floam/src/githubfish/doc.h:269: warning: Found unknown command `\x9'
/Users/floam/src/githubfish/doc.h:276: warning: Found unknown command `\u9'
/Users/floam/src/githubfish/doc.h:278: warning: Found unknown command `\U9'
/Users/floam/src/githubfish/doc.h:280: warning: Found unknown command `\ci'
/Users/floam/src/githubfish/doc.h:1527: warning: end of comment block while expecting command </code>
/Users/floam/src/githubfish/doc.h:1527: warning: end of comment block while expecting command </code>

MarkGriffiths · 2016-07-16T16:37:48Z

I just installed Doxygen from HEAD and see the same warnings.

As the warnings are being generated from items within backticks and escaping them causes double backticks \\ to be printed, my guess is that it's a currently unresolved issue in Doxygen HEAD.

I've checked through the documentation and there are no changes since 1.8.7 that could be affecting this. Despite the warnings, is the output correct?

Try installing the last official release 1.8.11?

floam · 2016-07-16T16:45:51Z

1.8.11 is fine here. I'm happy if you say so! Was hoping that this was just a doxygen bug.

floam · 2016-07-16T16:49:11Z

Although -

Despite the warnings, is the output correct?

No - the user_doc HTML is not looking good on 1.8.12/HEAD. (If you have it and see the warnings - check e.g. printf docs)

MarkGriffiths · 2016-07-16T17:10:06Z

Yep - it's the same here for HEAD. Once it hits the first error it's not breaking out of the fenced code block correctly. Digging deeper it's happening inside Doxygen's rendering process (which uses 2 passes when Markdown is enabled). This is evidenced by the fact that the reported line numbers for doc.h don't match the source.

I'll keep an eye on it as Doxygen approaches cutting its next release, but their HEAD is more of a work-in-progress compared to fish's.

krader1961 · 2016-07-17T03:34:53Z

Merged. We can't thank you enough @MarkGriffiths for your help with the documentation issues.

Fix documentation

MarkGriffiths added 2 commits July 16, 2016 11:27

Fix documentation

8b45cd2

Restores erroneous changes to lexicon_filter and changes to doc_src/ pages. Done by hand to ensure version history. Fixes display of % when misinterpreted by Doxygen.

Fix imbalanced backticks

94a094b

Only found one instance, which I’d already identified.

floam mentioned this pull request Jul 16, 2016

Restore lexicon_filter and doc syntax with tags #3198

Closed

2 tasks

krader1961 closed this Jul 17, 2016

floam added a commit to floam/fish-shell that referenced this pull request Jul 18, 2016

Merge pull request fish-shell#3247 from MarkGriffiths/fix_docs

0513f63

Fix documentation

floam mentioned this pull request Jul 21, 2016

Doxygen XML tags should be restored #3197

Closed

2 tasks

zanchey mentioned this pull request Jul 21, 2016

"fg ema" lacks "%" mark in Process expansion example fish-shell/fish-site#40

Closed

floam added this to the next-2.x milestone Aug 2, 2016

floam added bug Something that's not working as intended cleanup regression Something that used to work, but was broken, especially between releases labels Aug 2, 2016

krader1961 modified the milestones: fish 2.4.0, next-2.x Sep 3, 2016

github-actions bot locked as resolved and limited conversation to collaborators Apr 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix documentation #3247

Fix documentation #3247

MarkGriffiths commented Jul 16, 2016

floam commented Jul 16, 2016

MarkGriffiths commented Jul 16, 2016

floam commented Jul 16, 2016

floam commented Jul 16, 2016 •

edited

Loading

MarkGriffiths commented Jul 16, 2016

krader1961 commented Jul 17, 2016

Fix documentation #3247

Fix documentation #3247

Conversation

MarkGriffiths commented Jul 16, 2016

Description

TODOs:

floam commented Jul 16, 2016

MarkGriffiths commented Jul 16, 2016

floam commented Jul 16, 2016

floam commented Jul 16, 2016 • edited Loading

MarkGriffiths commented Jul 16, 2016

krader1961 commented Jul 17, 2016

floam commented Jul 16, 2016 •

edited

Loading