Skip to content

Commit

Permalink
Update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
Den Delimarsky committed Mar 14, 2019
1 parent 18cabc4 commit 41c29cb
Show file tree
Hide file tree
Showing 82 changed files with 85 additions and 85 deletions.
2 changes: 1 addition & 1 deletion filesys/cdfs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Cdfs is a read-only file system that addresses various issues such as accessing

## Universal Windows Driver Compliant

This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
2 changes: 1 addition & 1 deletion filesys/fastfat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ You can build a driver from the command line using the Visual Studio Command Pro
Installation
------------

No INF file is provided with this sample because the *fastfat* file system driver (fastfat.sys) is already part of the Windows operating system. You can build a private version of this file system and use it as a replacement for the native driver.
No INF file is provided with this sample because the *fastfat* file system driver (fastfat.sys) is already part of the Windows operating system. You can build a private version of this file system and use it as a replacement for the native driver.
2 changes: 1 addition & 1 deletion filesys/miniFilter/MetadataManager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ Similarly, the minifilter might close its metadata file if it sees an explicit F

The metadata minifilter also handles the case when a snapshot of its volume object is being taken. In this scenario, the minifilter acquires a shared exclusive lock on the metadata resource object while calling the callback that corresponds to the pre-device control operation for IOCTL\_VOLSNAP\_FLUSH\_AND\_HOLD\_WRITES. The lock is later released in the callback that corresponds to the post-device control operation for IOCTL\_VOLSNAP\_FLUSH\_AND\_HOLD\_WRITES. The lock is acquired to prevent any modifications on the metadata file while the snapshot is being taken.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/NameChanger/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ F:\\X\\Y

After the minifilter attaches, the "B" subdirectory of F:\\A is no longer visible. Its contents now appear under the "Y" subdirectory of F:\\X.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/avscan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ The AvScan minifilter is a transaction-aware file scanner. This is an example fo

## Universal Windows Driver Compliant

This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
2 changes: 1 addition & 1 deletion filesys/miniFilter/cancelSafe/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@ Design and Operation

The *CancelSafe* minifilter initializes a cancel-safe queue when it is attached to a volume. When the minifilter is deployed, it monitors read operations that are passing through the I/O stack. If the read operation is being performed on a file named csqdemo.txt, it is queued onto the cancel-safe queue. Queued operations are completed after a brief pause through a separate worker thread that is running in system context.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/cdo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ Design and Operation

When the CDO minifilter is deployed, it creates a CDO object named "FileSystem\\Filters\\CdoSample" in the Microsoft Windows object namespace and enables applications to open it and perform certain operations on it.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/change/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ The primary tasks of the filter for tracking a transacted file are the following

## Universal Windows Driver Compliant

This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
This sample builds a Universal Windows Driver. It uses only APIs and DDIs that are included in OneCoreUAP.
2 changes: 1 addition & 1 deletion filesys/miniFilter/ctx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a

The *Ctx* minifilter demonstrates how to attach and remove contexts from instances, files, steams, and stream handles. *Ctx* attaches a context whenever one of these objects is created. While attaching a context to a file, the sample also creates a stream and stream handle context. All contexts are ultimately deleted by the filter manager using the callback function that the *Ctx* minifilter provides.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/delete/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ The *delete* minifilter illustrates how to detect deletion of files and streams.

**Note** Because of the way in which the Windows operating system deletes files, it is not possible for the minifilter to detect in advance that a file or stream will be deleted. The minifilter can only detect operations that may cause a deletion, and then determine if the deletion took place after the operation completes.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/minispy/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Minispy consists of both user-mode and kernel-mode components. The kernel-mode c

To observe I/O activity on a device, you must explicitly attach Minispy to that device by using the Minispy user-mode component. Similarly, you can request Minispy to stop logging data for a particular device.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/nullFilter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a

The *NullFilter* minifilter is a simple minifilter that registers itself with the filter manager for no callback operations.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/passThrough/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a

The *PassThrough* minifilter does not have any real functionality. For each type of I/O operation, the same pre and post callback functions are called. These callback functions simply forward the I/O request to the next filter on the stack.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/scanner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ The Scanner minifilter comprises both kernel-mode and user-mode components. The

The kernel-mode component scans files with specific extensions only. The file is first scanned on a successful open. If the file was opened with write access, it is scanned again before a close. Scanning is also performed on data that is about to be written to a file. Writes will be rejected if any occurrences of a "foul" string are found in the data. If a "foul" string is detected during the closing of a file, a debug message is printed.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/simrep/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,4 @@ SimRep decides to reparse according to a mapping. The mapping is made up of a "N

It is important to note that SimRep does not take long and short names into account. It literally does a string comparison to detect overlap with the mapping paths. SimRep also handles IRP\_MJ\_NETWORK\_QUERY\_OPEN. Because network query opens are FastIo operations, they cannot be reparsed. This means network query opens which need to be redirected must be failed with FLT\_PREOP\_DISALLOW\_FASTIO. This will cause the Io Manager to reissue the open as a regular IRP based open. To prevent performance regression, SimRep only fails network query opens which need to be reparsed.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion filesys/miniFilter/swapBuffers/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ This sample builds a Universal Windows Driver. It uses only APIs and DDIs that a

The *SwapBuffers* minifilter introduces a new buffer before a read/write or directory control operations. The corresponding operation is then performed on the new buffer instead of the buffer that was originally provided. After the operation completes, the contents of the new buffer are copied back in to the original buffer.

For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
For more information on file system minifilter design, start with the [File System Minifilter Drivers](http://msdn.microsoft.com/en-us/library/windows/hardware/ff540402) section in the Installable File Systems Design Guide.
2 changes: 1 addition & 1 deletion general/DCHU/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ be installed in the following order:
* `osrfx2_DCHU_extension`
* `osrfx2_DCHU_component`

Technically the order of `osrfx2_DCHU_extension` and `osrfx2_DCHU_component` doesn't matter, but the software within `osrfx2_DCHU_component` will read the registry set by the extension to show that an extension INF's settings are applied *after* the base INF's.
Technically the order of `osrfx2_DCHU_extension` and `osrfx2_DCHU_component` doesn't matter, but the software within `osrfx2_DCHU_component` will read the registry set by the extension to show that an extension INF's settings are applied *after* the base INF's.
2 changes: 1 addition & 1 deletion general/PLX9x5x/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ The device is a PCI device with port, memory, interrupt and DMA resources. Devic

To test the driver, run the PLX.EXE test application.

This sample driver is a minimal driver meant to demonstrate the usage of the Windows Driver Framework. It is not intended for use in a production environment.
This sample driver is a minimal driver meant to demonstrate the usage of the Windows Driver Framework. It is not intended for use in a production environment.
2 changes: 1 addition & 1 deletion general/SystemDma/wdm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ The sample consists of a legacy device driver and a Win32 console mode test appl

## Run the sample

To test this driver, copy the test app, SystemDmaApp.exe, and the driver to the same directory, and run the application. The application will automatically load the driver if it's not already loaded and interact with the driver. When you exit the app, the driver will be stopped, unloaded and removed. Because no system DMA controller exists for Windows which uses the advertised DRQ, the sample driver will not proceed any further than failing to acquire a system DMA adapter.
To test this driver, copy the test app, SystemDmaApp.exe, and the driver to the same directory, and run the application. The application will automatically load the driver if it's not already loaded and interact with the driver. When you exit the app, the driver will be stopped, unloaded and removed. Because no system DMA controller exists for Windows which uses the advertised DRQ, the sample driver will not proceed any further than failing to acquire a system DMA adapter.
2 changes: 1 addition & 1 deletion general/WinHEC 2017 Lab/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ products:

# WinHEC 2017 Lab

Toaster samples from the WinHEC 2017 Lab: Toaster Driver, PlugInToaster, and Toaster Support App.
Toaster samples from the WinHEC 2017 Lab: Toaster Driver, PlugInToaster, and Toaster Support App.
2 changes: 1 addition & 1 deletion general/cancel/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ To test this driver, run Testapp.exe, which is a simple Win32 multithreaded cons

`Usage: testapp <NumberOfThreads>`

**Note** The `NumberOfThreads` command-line parameter is limited to a maximum of 10 threads; the default value if no parameter is specified is 1. The main thread waits for user input. If you press Q, the application exits gracefully; otherwise, it exits the process abruptly and forces all the threads to be terminated and all pending I/O operations to be canceled. Other threads perform I/O asynchronously in a loop. After every overlapped read, the thread goes into an alertable sleep and wakes as soon as the completion routine runs, which occurs when the driver completes the read IRP. You should run multiple instances of the application to stress test the driver.
**Note** The `NumberOfThreads` command-line parameter is limited to a maximum of 10 threads; the default value if no parameter is specified is 1. The main thread waits for user input. If you press Q, the application exits gracefully; otherwise, it exits the process abruptly and forces all the threads to be terminated and all pending I/O operations to be canceled. Other threads perform I/O asynchronously in a loop. After every overlapped read, the thread goes into an alertable sleep and wakes as soon as the completion routine runs, which occurs when the driver completes the read IRP. You should run multiple instances of the application to stress test the driver.
2 changes: 1 addition & 1 deletion general/echo/kmdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,4 +94,4 @@ This file merely redirects to the real makefile that is shared by all the driver

Sources

Generic file that lists source files and all the build options.
Generic file that lists source files and all the build options.
2 changes: 1 addition & 1 deletion general/echo/umdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,4 +129,4 @@ File Manifest
**echodriver.ctl**

- This file lists the WPP trace control GUID(s) for the sample driver. This file can be used with the tracelog command's -guid flag to enable the collection of these trace events within an established trace session.
- These GUIDs must remain in sync with the trace control GUIDs defined in internal.h.
- These GUIDs must remain in sync with the trace control GUIDs defined in internal.h.
2 changes: 1 addition & 1 deletion general/echo/umdf2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ As an alternative to building the driver sample in Visual Studio, you can build

**msbuild /p:configuration="Release" /p:platform="Win32" umdf2echo.sln**

For more information about using MSBuild to build a driver package, see [Building a Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644).
For more information about using MSBuild to build a driver package, see [Building a Driver](http://msdn.microsoft.com/en-us/library/windows/hardware/ff554644).
2 changes: 1 addition & 1 deletion general/echo/umdfSocketEcho/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,4 +174,4 @@ Note that independent threads perform the reads and writes in the echo test appl
File Manifest
-------------

**Dllsup.cpp**: The DLL support code that provides the DLL's entry point and the single required export (DllGetClassObject).
**Dllsup.cpp**: The DLL support code that provides the DLL's entry point and the single required export (DllGetClassObject).
2 changes: 1 addition & 1 deletion general/event/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ To run the test application, enter the following command in the command window:

`C:\>event.exe <Delay> <0|1>`

The first command-line parameter, `Delay`, equals the time, in seconds, to delay the event signal. For the second command-line parameter, specify 0 for IRP-based notification and 1 for event-based notification.
The first command-line parameter, `Delay`, equals the time, in seconds, to delay the event signal. For the second command-line parameter, specify 0 for IRP-based notification and 1 for event-based notification.
2 changes: 1 addition & 1 deletion general/filehistory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ The `path` command-line parameter is the path name of a storage device to use as

`fhsetup \\server\share`

If the specified target is inaccessible, read-only, an invalid drive type (such as a CD), already being used for file history, or part of the protected namespace, the application fails the request and does not enable file history on the target.
If the specified target is inaccessible, read-only, an invalid drive type (such as a CD), already being used for file history, or part of the protected namespace, the application fails the request and does not enable file history on the target.
2 changes: 1 addition & 1 deletion general/ioctl/kmdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ KmdfService = \<your driver service name here\>, \<driver service install subsec

KmdfLibraryVersion = \<version bound to here, in Major.minor format\>

For example, for V1.0 KmdfLibraryVersion is "1.0"
For example, for V1.0 KmdfLibraryVersion is "1.0"
Loading

0 comments on commit 41c29cb

Please sign in to comment.