Simplify copying and pasting commands from CONTRIBUTING.md into cmd.exe; etc. (#2390)
* Simplify copying and pasting commands from CONTRIBUTING.md into cmd.exe; etc. A) This patch makes it easier for users to copy and paste your suggested commands into a console window. (Yes, the trailing carriage returns are important. For a set of four commands to run automatically, the user must include a trailing carriage return on the clipboard before clicking "Paste".) B) The patch also makes the main text of the file slightly easier to read and understand. * Minor updates to logman commands. * Update CONTRIBUTING.md
unforgettableid committed
Aug 8, 2017 at 12:16 UTC
cdb2fe7bdecdfb515a43c8e53484f1e116a34587
1 file changed
+19
-23
CONTRIBUTING.md
+19
-23
@@ -20,7 +20,7 @@ A title succinctly describing the issue.
20
Your Windows build number. This can be gathered from the CMD prompt using the `ver` command.
21
22
```
23
-C:\>ver
23
+C:\> ver
24
Microsoft Windows [Version 10.0.14385]
25
```
26
@@ -36,15 +36,14 @@ Should include all packages and environmental variables as well as other require
36
37
#### Example:
38
39
-`$ sudo apt-get install traceroute`
40
-`$ traceroute www.microsoft.com`
39
+`$ sudo apt-get install traceroute && traceroute www.microsoft.com`
40
41
### 4) Copy of the terminal output
42
43
#### Example:
44
45
```
47
-russ@RUSSALEX-BOOK:/mnt/c$ traceroute www.microsoft.com
46
+$ traceroute www.microsoft.com
47
traceroute to www.microsoft.com (23.75.239.28), 30 hops max, 60 byte packets
48
setsockopt IP_MTU_DISCOVER: Invalid argument
49
```
@@ -66,7 +65,7 @@ Strace can produce a very long output. If this is more than about 20 lines plea
65
#### Example:
66
67
```
69
-russ@RUSSALEX-BOOK:/mnt/c$ strace traceroute www.microsoft.com
68
+$ strace traceroute www.microsoft.com
69
execve("/usr/bin/traceroute", ["traceroute", "www.microsoft.com"], [/* 22 vars */]) = 0
70
brk(0) = 0x7fffdd3bc000
71
access("/etc/ld.so.nohwcap", F_OK) = -1 ENOENT (No such file or directory)
@@ -96,30 +95,27 @@ $ strace -ff -o <outputfile> <command>
95
### 8) Detailed Logs
96
Some bugs will require more detailed logs to help determine the cause. There is a CMD command to start detailed logging and another to stop. The logs are generated locally into the working directory.
97
99
-#### Start
98
+#### Start collecting logs
99
101
-```
102
->logman.exe create trace lxcore_kernel -p {0CD1C309-0878-4515-83DB-749843B3F5C9} -mode 0x00000008 -ft 10:00 -o .\lxcore_kernel.etl -ets
103
->logman create trace lxcore_adss -p {754E4536-6735-4194-BE81-1374BD2E9B0D} -ft 1:00 -rt -o .\lxcore_adss.etl -ets
104
->logman create trace lxcore_user -p {D90B9468-67F0-5B3B-42CC-82AC81FFD960} -ft 1:00 -rt -o .\lxcore_user.etl -ets
105
->logman create trace lxcore_service -p {B99CDB5A-039C-5046-E672-1A0DE0A40211} -ft 1:00 -rt -o .\lxcore_service.etl -ets
106
-```
100
+```
101
+logman.exe create trace lxcore_kernel -p {0CD1C309-0878-4515-83DB-749843B3F5C9} -mode 0x00000008 -ft 10:00 -o .\lxcore_kernel.etl -ets
102
+logman.exe create trace lxcore_user -p {D90B9468-67F0-5B3B-42CC-82AC81FFD960} -ft 1:00 -rt -o .\lxcore_user.etl -ets
103
+logman.exe create trace lxcore_service -p {B99CDB5A-039C-5046-E672-1A0DE0A40211} -ft 1:00 -rt -o .\lxcore_service.etl -ets
104
+```
105
108
-#### Stop
106
+#### Stop collecting logs
107
110
-```
111
->logman stop lxcore_kernel -ets
112
->logman stop lxcore_adss -ets
113
->logman stop lxcore_user -ets
114
->logman stop lxcore_service -ets
115
-```
108
+```
109
+logman.exe stop lxcore_kernel -ets
110
+logman.exe stop lxcore_user -ets
111
+logman.exe stop lxcore_service -ets
112
+```
113
117
-#### Output
114
+#### Generated log files
115
119
-Files generated are in the directory where the commands above ran:
116
+The files generated will be in the directory where the above commands ran. The files will be named:
117
121
-```
122
-lxcore_adss.etl
118
+```
119
lxcore_kernel.etl
120
lxcore_service.etl
121
lxcore_user.etl