[Bug 261944] FFS/UFS: explain soft update journaling (SUJ) in documentation and in tunefs(8)

From: <bugzilla-noreply_at_freebsd.org>
Date: Mon, 14 Feb 2022 07:43:30 UTC
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261944

            Bug ID: 261944
           Summary: FFS/UFS: explain soft update journaling (SUJ) in
                    documentation and in tunefs(8)
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Documentation
          Assignee: doc@FreeBSD.org
          Reporter: grahamperrin@gmail.com

We have mentions of the feature, however (unless I'm missing something): 

* there's nothing like a plain English explanation of the feature. 

As far as I can tell, this bug affects: 

* documentation, including the FreeBSD Handbook and its detached glossary 
  e.g. <https://docs.freebsd.org/en/books/handbook/glossary/#_s>

* manual pages, e.g. tuning(7) 
  <https://www.freebsd.org/cgi/man.cgi?query=tuning&sektion=7&manpath=FreeBSD> 
  and/or tunefs(8) 
  <https://www.freebsd.org/cgi/man.cgi?query=tunefs&sektion=8&manpath=FreeBSD>

For a manual page: a single sentence should suffice. 

For more detailed documentation: something more explanatory, to include pros
and cons. 

Thanks

-- 
You are receiving this mail because:
You are the assignee for the bug.