From 0ac2f67437702ee47e65b6d51a793301791b277e Mon Sep 17 00:00:00 2001 From: "Bobby R. Bruce" Date: Sat, 2 Sep 2023 04:41:08 -0700 Subject: [PATCH 1/4] misc: Remove escape characters from bug_report.md The bug_report.md is rendered as plain text, not markdown, when creating a bug report. As such the escape characters are removed in this commit. Change-Id: I524c66ae61d00b7ed59153ba9f4b2297ff50ee18 --- .github/ISSUE_TEMPLATE/bug_report.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 179a37ac0b..8cbf4c6db2 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,10 +21,10 @@ Steps to reproduce the behavior. Please assume starting from a clean repository: 1. Compile gem5 with command ... 2. Execute the simulation with... -If writing code, or a terminal command, use code blocks. Either an inline code block, \`scons build/ALL/gem5.opt\` (enclosed in two \`) or a multi-line codeblock: +If writing code, or a terminal command, use code blocks. Either an inline code block, `scons build/ALL/gem5.opt` (enclosed in two '`') or a multi-line codeblock: -\`\`\` +``` int x=2; @@ -32,7 +32,7 @@ int y=3' print(x+y); -\`\`\` +``` If possible, please include the Python configuration script used and state clearly any parameters passed. @@ -40,11 +40,11 @@ If possible, please include the Python configuration script used and state clear If applicable, add the terminal output here. If long, only include the relevant lines. Please put the terminal output in code blocks. I.e.: -\`\`\` +``` #Terminal output here# -\`\`\` +``` **Expected behavior** A clear and concise description of what you expected to happen. From fcb586cfedeaebe146ae270886dcf6c8f77f3070 Mon Sep 17 00:00:00 2001 From: "Bobby R. Bruce" Date: Sat, 2 Sep 2023 04:42:53 -0700 Subject: [PATCH 2/4] misc: Add/Remove new lines from bug_report.md There were some weird newline characters in this file, or lack of lines. This patch adds/removes them. Change-Id: I6cc918788c07bbc4be5c68401ad3987be00fffc4 --- .github/ISSUE_TEMPLATE/bug_report.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 8cbf4c6db2..9600934675 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,7 +4,6 @@ about: Create a report to help us find and fix the bug title: '' labels: bug assignees: '' - --- **Describe the bug** @@ -18,6 +17,7 @@ If you have modified gem5 in some way please state, to the best of your ability, **To Reproduce** Steps to reproduce the behavior. Please assume starting from a clean repository: + 1. Compile gem5 with command ... 2. Execute the simulation with... @@ -25,13 +25,9 @@ If writing code, or a terminal command, use code blocks. Either an inline code b ``` - int x=2; - int y=3' - print(x+y); - ``` If possible, please include the Python configuration script used and state clearly any parameters passed. @@ -41,9 +37,7 @@ If applicable, add the terminal output here. If long, only include the relevant Please put the terminal output in code blocks. I.e.: ``` - #Terminal output here# - ``` **Expected behavior** From 188d29fe057947522d6159284b3669b132cd781b Mon Sep 17 00:00:00 2001 From: "Bobby R. Bruce" Date: Sat, 2 Sep 2023 04:44:07 -0700 Subject: [PATCH 3/4] misc: Add language specification to code-blocks Change-Id: I875aeee7eb0f9970711a97448d3bcb7acddbe7b1 --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9600934675..c7d10c1724 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -24,7 +24,7 @@ Steps to reproduce the behavior. Please assume starting from a clean repository: If writing code, or a terminal command, use code blocks. Either an inline code block, `scons build/ALL/gem5.opt` (enclosed in two '`') or a multi-line codeblock: -``` +```python int x=2; int y=3' print(x+y); @@ -36,7 +36,7 @@ If possible, please include the Python configuration script used and state clear If applicable, add the terminal output here. If long, only include the relevant lines. Please put the terminal output in code blocks. I.e.: -``` +```shell #Terminal output here# ``` From 1ec58d589a3dfe76c144b2257dba2205fc9eada1 Mon Sep 17 00:00:00 2001 From: "Bobby R. Bruce" Date: Sat, 2 Sep 2023 04:46:04 -0700 Subject: [PATCH 4/4] misc: Fix broken code example in bug_report.md Change-Id: I9bc1b42d488a415d2ea165385d83fea3d4ac288d --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c7d10c1724..6f89a7eb33 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -25,9 +25,9 @@ If writing code, or a terminal command, use code blocks. Either an inline code b ```python -int x=2; -int y=3' -print(x+y); +int x=2 +int y=3 +print(x+y) ``` If possible, please include the Python configuration script used and state clearly any parameters passed.