summaryrefslogtreecommitdiff
path: root/tools/dv
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-03-12 14:02:43 -0700
committerAdonais Romero González <[email protected]>2019-03-12 14:02:43 -0700
commitef7ec4ec9ff7ce3c53d60e1c8906915966e17e01 (patch)
tree3017523a73c6552c27947d402afa6062f4df2706 /tools/dv
parent35bff356ac249057f4d673d39c7f28ed348cbf0f (diff)
Update README.md for samples portal (#358)
* Update README.md for samples portal * Update README.md for samples portal * Removed installwdf * Update fork (#2) * Fix typo ture -> true * Remove InstallWdf sample * Fix typo (#340) ture -> true * Readme typo fix (#349) * Update langid
Diffstat (limited to 'tools/dv')
-rw-r--r--tools/dv/samples/DV-FailDriver-WDM/README.md32
-rw-r--r--tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml12
2 files changed, 20 insertions, 24 deletions
diff --git a/tools/dv/samples/DV-FailDriver-WDM/README.md b/tools/dv/samples/DV-FailDriver-WDM/README.md
index 9851ff31..f8675419 100644
--- a/tools/dv/samples/DV-FailDriver-WDM/README.md
+++ b/tools/dv/samples/DV-FailDriver-WDM/README.md
@@ -1,3 +1,13 @@
+---
+topic: sample
+name: DV-FailDriver-WDM
+description: Demonstrates how Driver Verifier (DV) can find errors in a WDM driver.
+languages:
+ - cpp
+products:
+ - windows
+---
+
<!---
name: DV-FailDriver-WDM
platform: WDM
@@ -7,26 +17,24 @@
samplefwlink: https://go.microsoft.com/fwlink/p/?linkid=856743
--->
-
-DV-FailDriver-WDM
-=================
+# DV-FailDriver-WDM
The DV-FailDriver-WDM sample driver contains intentional code errors that are designed to show the capabilities and features of [Driver Verifier](https://msdn.microsoft.com/en-us/library/windows/hardware/ff545448) (DV) and the [Device Fundamentals tests](https://msdn.microsoft.com/en-us/library/windows/hardware/jj673011). Driver Verifier is a component of the Windows kernel designed to detect drivers that are behaving poorly and stop their execution via a bugcheck; the Device Fundamentals tests are a series of tests provided in the Windows Driver Kit (WDK) designed to provide a good basic set of tests against a driver.
**Caution** This sample driver contains intentional code errors that are designed to show the capabilities and features of DV and SDV. This sample driver is not intended as an example for real driver development projects.
-Build the sample for desktop
---------------
-1. In the **Solutions Explorer** window, select the driver solution (DV-FailDriver-WDM).
+## Build the sample for desktop
+
+1. In the **Solutions Explorer** window, select the driver solution (DV-FailDriver-WDM).
-2. From the **Build** menu, select **Build Solution**.
+1. From the **Build** menu, select **Build Solution**.
+
+## Deploy the sample
-Deploy the sample
---------------
See [Deploying a Driver to a Test Computer](https://msdn.microsoft.com/en-us/library/windows/hardware/hh454834) for details on how to deploy the sample.
-Test the sample
---------------
+## Test the sample
+
See [How to test a driver at runtime](https://msdn.microsoft.com/en-us/library/windows/hardware/ff554820) for details on how to run tests on the Toastmon driver.
-To observe the injected defect being caught by DV, you should enable DV on the Toastmon driver, and then run the "DF - PNP Surprise Remove (Development and Integration)" test on the Toastmon sample driver and device. \ No newline at end of file
+To observe the injected defect being caught by DV, you should enable DV on the Toastmon driver, and then run the "DF - PNP Surprise Remove (Development and Integration)" test on the Toastmon sample driver and device.
diff --git a/tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml b/tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml
deleted file mode 100644
index 86c935f6..00000000
--- a/tools/dv/samples/DV-FailDriver-WDM/tools-dv-samples-dv-faildriver-wdm.yml
+++ /dev/null
@@ -1,12 +0,0 @@
-### YamlMime:Sample
-sample:
-- name: DV-FailDriver-WDM
- description: Demonstrates how Driver Verifier (DV) can find errors in a WDM driver.
- generateZip: true
- preserveParentHierarchy: true
- author: windows-driver-samples
- languages:
- - cpp
- technologies:
- - windows
- vssolution: /tools/dv/samples/DV-FailDriver-WDM/driver/DV-FailDriver-WDM.sln