/*
 * Copyright (c) Likewise Software.  All rights Reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the license, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
 * General Public License for more details.  You should have received a copy
 * of the GNU Lesser General Public License along with this program.  If
 * not, see <http://www.gnu.org/licenses/>.
 *
 * LIKEWISE SOFTWARE MAKES THIS SOFTWARE AVAILABLE UNDER OTHER LICENSING
 * TERMS AS WELL.  IF YOU HAVE ENTERED INTO A SEPARATE LICENSE AGREEMENT
 * WITH LIKEWISE SOFTWARE, THEN YOU MAY ELECT TO USE THE SOFTWARE UNDER THE
 * TERMS OF THAT SOFTWARE LICENSE AGREEMENT INSTEAD OF THE TERMS OF THE GNU
 * LESSER GENERAL PUBLIC LICENSE, NOTWITHSTANDING THE ABOVE NOTICE.  IF YOU
 * HAVE QUESTIONS, OR WISH TO REQUEST A COPY OF THE ALTERNATE LICENSING
 * TERMS OFFERED BY LIKEWISE SOFTWARE, PLEASE CONTACT LIKEWISE SOFTWARE AT
 * license@likewisesoftware.com
 */

/*
 * Module Name:
 *
 *        fsd-guide.doxy
 *
 * Abstract:
 *
 *        File system driver guide
 *
 * Authors: Brian Koropoff (bkoropoff@likewise.com)
 *
 */

/**
@page fsd-guide File System Driver Guide

-# @subpage fsd-setup
-# @subpage fsd-iomgr
-# @subpage fsd-security
-# @subpage fsd-async
-# @subpage fsd-design
-# @subpage fsd-scenarios

@page fsd-setup Setup

@section setup-driver Creating a Driver

Insert wisdom here.

@section setup-register Registering Devices

Insert wisdom here.

@page fsd-scenarios Specific Scenarios

-# @subpage fsd-create
-# @subpage fsd-finfo
-# @subpage fsd-delete
-# @subpage fsd-quota
-# @subpage fsd-snapshot
-# @subpage fsd-streams
-# @subpage fsd-sd
-# @subpage fsd-ea
-# @subpage fsd-fsinfo
-# @subpage fsd-oplock
-# @subpage fsd-brl
-# @subpage fsd-ecp
-# @subpage fsd-rw
-# @subpage fsd-fsctl
-# @subpage fsd-notify
-# @subpage fsd-dir
-# @subpage fsd-rename
-# @subpage fsd-hl
-# @subpage fsd-zc

@page fsd-create Opening and Closing Files

@section create-open Opening

Insert wisdom here.

@section create-close Closing

Insert wisdom here.

@page fsd-finfo File Information

@section finfo-query Querying

Insert wisdom here.

@section finfo-set Setting

Insert wisdom here.

@page fsd-delete Deleting a File

Insert wisdom here.

@page fsd-quota Quotas

@section quota-query Querying

Insert wisdom here.

@section quota-set Setting

Insert wisdom here.

@page fsd-streams Streams

@section stream-overview Overview

Insert wisdom here.

@section stream-name Stream Name Format

Insert wisdom here.

@section stream-dir Directory and File Streams

Insert wisdom here.

@section stream-del Deleting and Renaming Streams

Insert wisdom here.

@page fsd-sd Security Descriptors

@section sd-query Querying

Insert wisdom here.

@section sd-set Setting

Insert wisdom here.

@page fsd-ea Extended Attributes

Insert wisdom here.

@page fsd-fsinfo File System Information

@section fsinfo-query Querying

Insert wisdom here.

@section fsinfo-set Setting

Insert wisdom here.

@page fsd-oplock Oplocks and Leases

@section oplock-oplock Oplocks

Insert wisdom here.

@section oplock-lease Leases

Insert wisdom here.

@page fsd-brl Byte-range Locks

@section brl-lock Locking

Insert wisdom here.

@section brl-unlock Unlocking

Insert wisdom here.

@section brl-sem Lock Semantics

Insert wisdom here.

@page fsd-ecp ECPs

@section ecp-pass Passing ECPs

Insert wisdom here.

@section ecp-access Accessing ECPs

Insert wisdom here.

@section ecp-ack Acknowledging ECPs

Insert wisdom here.

@page fsd-rw Reading and Writing

@section rw-read Reading

Insert wisdom here.

@section rw-write Writing

Insert wisdom here.

@section rw-flush Flushing

Insert wisdom here.

@page fsd-fsctl Fsctl and Ioctl

@section fsctl-fsctl Fsctls

Insert wisdom here.

@section fsctl-ioctl Ioctls

Insert wisdom here.

@page fsd-notify Change Notification

Insert wisdom here.

@page fsd-dir Directory Enumeration

Insert wisdom here.

@page fsd-rename Renaming Files

Insert wisdom here.

@page fsd-hl Hard Links

Insert wisdom here.

@page fsd-zc Zero Copy

Insert wisdom here.

@page fsd-design Driver Design Practices

Insert wisdom here.

**/
