Commit f139291c authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

docs: fs: cifs: convert to ReST and add to admin-guide book 



The filenames for cifs documentation is not using the same
convention as almost all Kernel documents is using. So,
rename them to a more appropriate name. Then, manually convert
the documentation files for CIFS to ReST.

By doing a manual conversion, we can preserve the original
author's style, while making it to look more like the other
Kernel documents.

Most of the conversion here is trivial. The most complex one was
the README file (which was renamed to usage.rst).

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 9cdd273e

Documentation/filesystems/cifs/AUTHORS→Documentation/admin-guide/cifs/authors.rst

+35 −29
Original line number Diff line number Diff line 
=======

Authors

=======



Original Author

===============

---------------



Steve French (sfrench@samba.org)



The author wishes to express his appreciation and thanks to:
@@ -20,33 +25,34 @@ thanks to the Samba team for their technical advice and encouragement. 


Patch Contributors

------------------

Zwane Mwaikambo

Andi Kleen

Amrut Joshi

Shobhit Dayal

Sergey Vlasov

Richard Hughes

Yury Umanets

Mark Hamzy (for some of the early cifs IPv6 work)

Domen Puncer

Jesper Juhl (in particular for lots of whitespace/formatting cleanup)

Vince Negri and Dave Stahl (for finding an important caching bug)

Adrian Bunk (kcalloc cleanups)

Miklos Szeredi 

Kazeon team for various fixes especially for 2.4 version.

Asser Ferno (Change Notify support)

Shaggy (Dave Kleikamp) for innumerable small fs suggestions and some good cleanup

Gunter Kukkukk (testing and suggestions for support of old servers)

Igor Mammedov (DFS support)

Jeff Layton (many, many fixes, as well as great work on the cifs Kerberos code)

Scott Lovenberg

Pavel Shilovsky (for great work adding SMB2 support, and various SMB3 features)

Aurelien Aptel (for DFS SMB3 work and some key bug fixes)

Ronnie Sahlberg (for SMB3 xattr work, bug fixes, and lots of great work on compounding)

Shirish Pargaonkar (for many ACL patches over the years)

Sachin Prabhu (many bug fixes, including for reconnect, copy offload and security)

Paulo Alcantara

Long Li (some great work on RDMA, SMB Direct)



- Zwane Mwaikambo

- Andi Kleen

- Amrut Joshi

- Shobhit Dayal

- Sergey Vlasov

- Richard Hughes

- Yury Umanets

- Mark Hamzy (for some of the early cifs IPv6 work)

- Domen Puncer

- Jesper Juhl (in particular for lots of whitespace/formatting cleanup)

- Vince Negri and Dave Stahl (for finding an important caching bug)

- Adrian Bunk (kcalloc cleanups)

- Miklos Szeredi

- Kazeon team for various fixes especially for 2.4 version.

- Asser Ferno (Change Notify support)

- Shaggy (Dave Kleikamp) for innumerable small fs suggestions and some good cleanup

- Gunter Kukkukk (testing and suggestions for support of old servers)

- Igor Mammedov (DFS support)

- Jeff Layton (many, many fixes, as well as great work on the cifs Kerberos code)

- Scott Lovenberg

- Pavel Shilovsky (for great work adding SMB2 support, and various SMB3 features)

- Aurelien Aptel (for DFS SMB3 work and some key bug fixes)

- Ronnie Sahlberg (for SMB3 xattr work, bug fixes, and lots of great work on compounding)

- Shirish Pargaonkar (for many ACL patches over the years)

- Sachin Prabhu (many bug fixes, including for reconnect, copy offload and security)

- Paulo Alcantara

- Long Li (some great work on RDMA, SMB Direct)





Test case and Bug Report contributors

Documentation/filesystems/cifs/CHANGES→Documentation/admin-guide/cifs/changes.rst

+4 −0
Original line number Diff line number Diff line 
=======

Changes

=======



See https://wiki.samba.org/index.php/LinuxCIFSKernel for summary

information (that may be easier to read than parsing the output of

"git log fs/cifs") about fixes/improvements to CIFS/SMB2/SMB3 support (changes

Documentation/admin-guide/cifs/index.rst

0 → 100644
+21 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



====

CIFS

====



.. toctree::

   :maxdepth: 2



   introduction

   usage

   todo

   changes

   authors



.. only::  subproject and html



   Indices

   =======



   * :ref:`genindex`

Documentation/filesystems/cifs/cifs.txt→Documentation/admin-guide/cifs/introduction.rst

+8 −0
Original line number Diff line number Diff line 
============

Introduction

============



  This is the client VFS module for the SMB3 NAS protocol as well

  as for older dialects such as the Common Internet File System (CIFS)

  protocol which was the successor to the Server Message Block
@@ -33,7 +37,9 @@ 
  tools (including smbinfo and setcifsacl) that can be obtained from



      https://git.samba.org/?p=cifs-utils.git



  or



      git://git.samba.org/cifs-utils.git



  mount.cifs should be installed in the directory with the other mount helpers.
@@ -41,5 +47,7 @@ 
  For more information on the module see the project wiki page at



      https://wiki.samba.org/index.php/LinuxCIFS



  and



      https://wiki.samba.org/index.php/LinuxCIFS_utils

Documentation/filesystems/cifs/TODO→Documentation/admin-guide/cifs/todo.rst

+47 −40
Original line number Diff line number Diff line 
====

TODO

====



Version 2.14 December 21, 2018



A Partial List of Missing Features
@@ -8,6 +12,7 @@ for visible, important contributions to this module. Here 
is a partial list of the known problems and missing features:



a) SMB3 (and SMB3.1.1) missing optional features:



   - multichannel (started), integration with RDMA

   - directory leases (improved metadata caching), started (root dir only)

   - T10 copy offload ie "ODX" (copy chunk, and "Duplicate Extents" ioctl
@@ -23,7 +28,8 @@ to make it to network filesystems or deviceless filesystems) 


e) Additional use cases where we use "compoounding" (e.g. open/query/close

   and open/setinfo/close) to reduce the number of roundtrips, and also

open to reduce redundant opens (using deferred close and reference counts more).

   open to reduce redundant opens (using deferred close and reference counts

   more).



f) Finish inotify support so kde and gnome file list windows

   will autorefresh (partially complete by Asser). Needs minor kernel
@@ -52,9 +58,9 @@ l) encrypted file support 
m) improved stats gathering tools (perhaps integration with nfsometer?)

   to extend and make easier to use what is currently in /proc/fs/cifs/Stats



n) allow setting more NTFS/SMB3 file attributes remotely (currently limited to compressed

file attribute via chflags) and improve user space tools for managing and

viewing them.

n) allow setting more NTFS/SMB3 file attributes remotely (currently limited to

   compressed file attribute via chflags) and improve user space tools for

   managing and viewing them.



o) mount helper GUI (to simplify the various configuration options on mount)
@@ -82,8 +88,9 @@ so far). 
w) Add support for additional strong encryption types, and additional spnego

   authentication mechanisms (see MS-SMB2)



KNOWN BUGS

====================================

Known Bugs

==========



See http://bugzilla.samba.org - search on product "CifsVFS" for

current bug list.  Also check http://bugzilla.kernel.org (Product = File System, Component = CIFS)

CRA Git | Maintained and supported by SUSTech CRA and CCSE