Bug 233393

Summary:	[FUSEFS]: no manual pages for fusefs
Product:	Documentation	Reporter:	tech-lists
Component:	Manual Pages	Assignee:	Alan Somers <asomers>
Status:	Closed FIXED
Severity:	Affects Many People	CC:	asomers, doc, lapo
Priority:	---
Version:	Latest
Hardware:	Any
OS:	Any

Description tech-lists 2018-11-21 23:59:07 UTC

There is no manual for fuse. Why?

[@desktop /usr/src ] man fuse
No manual entry for fuse
[@desktop /usr/src ] man fuse.ko
No manual entry for fuse.ko
[@desktop /usr/src ] man fusefs
No manual entry for fusefs
[@desktop /usr/src ] apropos fuse
fuser(1) - list IDs of all processes that have one or more files open
mount_fusefs(8) - mount a Fuse file system daemon
dtrace_tcp(4) - a DTrace provider for tracing events related to the tcp 4 protocol
fma, fmaf, fmal(3) - fused multiply-add
blackhole(4) - a sysctl 8 MIB for manipulating behaviour in respect of refused SCTP, TCP, or UDP connection attempts
nologin(8) - politely refuse a login

desktop /usr/src ] find . -type f -name "fuse*"
./usr.bin/fstat/fuser.1
./usr.bin/fstat/fuser.c
./contrib/file/magic/Magdir/fusecompress
./sys/fs/fuse/fuse_io.h
./sys/fs/fuse/fuse_node.h
./sys/fs/fuse/fuse_device.c
./sys/fs/fuse/fuse_debug.h
./sys/fs/fuse/fuse_file.c
./sys/fs/fuse/fuse_internal.h
./sys/fs/fuse/fuse.h
./sys/fs/fuse/fuse_ipc.h
./sys/fs/fuse/fuse_vnops.c
./sys/fs/fuse/fuse_kernel.h
./sys/fs/fuse/fuse_internal.c
./sys/fs/fuse/fuse_file.h
./sys/fs/fuse/fuse_param.h
./sys/fs/fuse/fuse_io.c
./sys/fs/fuse/fuse_main.c
./sys/fs/fuse/fuse_node.c
./sys/fs/fuse/fuse_ipc.c
./sys/fs/fuse/fuse_vfsops.c

Comment 1 Alan Somers freebsd_committer

2018-12-04 23:18:57 UTC

Why? Because pretty much everything is covered by mount_fusefs(8).  smbfs and unionfs are in the same boat.  But it would be nice to add a fusefs(5) man page too.

Comment 2 Alan Somers freebsd_committer

2019-03-21 20:53:54 UTC

Man page under review at https://reviews.freebsd.org/D19651

Comment 3 commit-hook freebsd_committer

2019-04-13 13:59:59 UTC

A commit references this bug:

Author: asomers
Date: Sat Apr 13 13:59:02 UTC 2019
New revision: 346186
URL: https://svnweb.freebsd.org/changeset/base/346186

Log:
  fusefs: add a fusefs(5) man page

  PR:		233393
  Reported by:	tech-lists@zyxst.net
  Reviewed by:	cem
  MFC after:	2 weeks
  Sponsored by:	The FreeBSD Foundation
  Differential Revision:	https://reviews.freebsd.org/D19651

Changes:
  head/share/man/man5/Makefile
  head/share/man/man5/fusefs.5

Comment 4 commit-hook freebsd_committer

2019-09-06 18:10:54 UTC

A commit references this bug:

Author: asomers
Date: Fri Sep  6 18:10:03 UTC 2019
New revision: 351946
URL: https://svnweb.freebsd.org/changeset/base/351946

Log:
  MFC r346186:

  fusefs: add a fusefs(5) man page

  PR:		233393
  Reported by:	tech-lists@zyxst.net
  Reviewed by:	cem
  Sponsored by:	The FreeBSD Foundation
  Differential Revision:	https://reviews.freebsd.org/D19651

Changes:
_U  stable/12/
  stable/12/share/man/man5/Makefile
  stable/12/share/man/man5/fusefs.5

Comment 5 Alan Somers freebsd_committer

2019-09-06 18:18:31 UTC

MFC complete.  No MFC to stable/11 because no new releases are planned for that branch.