From 04721e90b4d7f3f685095260012553cc1a08f007 Mon Sep 17 00:00:00 2001 From: Hugo McNally Date: Wed, 8 Feb 2023 09:26:47 +0000 Subject: [PATCH] [doc mv] contrib, get srt and prj gov for new doc Moved files for the contributing and project government sections, and the getting started book. No file has been modified, so that git can more easily track moved files. Exceptions to this are `{hw,ug}/_index.md` which had no content and `hw_checklist.md.tpl` which is a symlink that needed updating. Signed-off-by: Hugo McNally Co-authored-by: Harry Callahan Co-authored-by: James Wainwright --- doc/_index.md | 5 ----- .../contributing.md => contributing/README.md} | 0 doc/{ug => contributing}/bazel_notes.md | 0 .../index.md => contributing/ci/README.md} | 0 .../ci}/continuous_integration_overview.svg | 0 .../detailed_contribution_guide/README.md} | 0 .../contributing_code_flow_chart.svg | 0 doc/{ug => contributing}/directory_structure.md | 0 .../dv/methodology/README.md} | 0 .../dv/methodology}/dv_method_multi_gate.svg | 0 .../dv/methodology}/dv_method_single_gate.svg | 0 .../dv/sec_cm_dv_framework/README.md} | 0 ...gram_of_block_that_contains_sec_cm_primitive.svg | 0 .../sec_cm_dv_framework/diagram_of_sec_cm_prim.svg | 0 .../fpga/get_a_board.md} | 0 doc/{rm => contributing/fpga}/ref_manual_fpga.md | 0 doc/{ug => contributing}/github_notes.md | 0 .../hw/comportability/README.md} | 0 .../comportability_diagram_intr_hw.svg | 0 .../comportability_diagram_peripheral.svg | 0 doc/{ug/hw_design.md => contributing/hw/design.md} | 0 .../design.md => contributing/hw/methodology.md} | 0 doc/{ug/vendor_hw.md => contributing/hw/vendor.md} | 0 .../style_guides/README.md} | 0 .../style_guides}/asm_coding_style.md | 0 .../style_guides}/c_cpp_coding_style.md | 0 .../style_guides}/guidance_for_volatile.md | 0 .../style_guides}/hjson_usage_style.md | 0 .../style_guides}/markdown_usage_style.md | 0 .../style_guides}/otbn_style_guide.md | 0 .../style_guides}/python_coding_style.md | 0 .../sw}/device_interface_functions.md | 0 doc/{ug => contributing/sw}/otbn_sw.md | 0 doc/{ug => contributing}/system_list.md | 0 .../getting_started/src/README.md} | 0 .../getting_started/src/build_docs.md} | 0 .../getting_started/src}/build_sw.md | 0 .../src}/getting_started_workflow.svg | 0 .../getting_started/src}/install_openocd.md | 0 .../getting_started/src/install_vivado/README.md} | 0 .../src}/install_vivado/features.png | Bin .../getting_started/src}/setup_dv.md | 0 .../getting_started/src}/setup_formal.md | 0 .../getting_started/src}/setup_fpga.md | 0 .../getting_started/src}/setup_verilator.md | 0 doc/project/hw_checklist.md.tpl | 1 - .../_index.md => project_governance/README.md} | 0 .../checklist/README.md} | 0 .../checklist/hw_checklist.md.tpl | 1 + .../checklist}/sw_checklist.md.tpl | 0 doc/{project => project_governance}/committers.md | 0 .../development_stages.md | 0 .../priority_definitions.md | 0 doc/{project => project_governance}/rfc_process.md | 0 .../technical_committee.md | 0 doc/{ug/rust_for_c.md => rust_for_c_devs.md} | 0 doc/ug/_index.md | 5 ----- 57 files changed, 1 insertion(+), 11 deletions(-) delete mode 100644 doc/_index.md rename doc/{project/contributing.md => contributing/README.md} (100%) rename doc/{ug => contributing}/bazel_notes.md (100%) rename doc/{rm/continuous_integration/index.md => contributing/ci/README.md} (100%) rename doc/{rm/continuous_integration => contributing/ci}/continuous_integration_overview.svg (100%) rename doc/{project/detailed_contribution_guide/_index.md => contributing/detailed_contribution_guide/README.md} (100%) rename doc/{project => contributing}/detailed_contribution_guide/contributing_code_flow_chart.svg (100%) rename doc/{ug => contributing}/directory_structure.md (100%) rename doc/{ug/dv_methodology/index.md => contributing/dv/methodology/README.md} (100%) rename doc/{ug/dv_methodology => contributing/dv/methodology}/dv_method_multi_gate.svg (100%) rename doc/{ug/dv_methodology => contributing/dv/methodology}/dv_method_single_gate.svg (100%) rename doc/{ug/sec_cm_dv_framework/index.md => contributing/dv/sec_cm_dv_framework/README.md} (100%) rename doc/{ug => contributing/dv}/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg (100%) rename doc/{ug => contributing/dv}/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg (100%) rename doc/{ug/fpga_boards.md => contributing/fpga/get_a_board.md} (100%) rename doc/{rm => contributing/fpga}/ref_manual_fpga.md (100%) rename doc/{ug => contributing}/github_notes.md (100%) rename doc/{rm/comportability_specification/index.md => contributing/hw/comportability/README.md} (100%) rename doc/{rm/comportability_specification => contributing/hw/comportability}/comportability_diagram_intr_hw.svg (100%) rename doc/{rm/comportability_specification => contributing/hw/comportability}/comportability_diagram_peripheral.svg (100%) rename doc/{ug/hw_design.md => contributing/hw/design.md} (100%) rename doc/{ug/design.md => contributing/hw/methodology.md} (100%) rename doc/{ug/vendor_hw.md => contributing/hw/vendor.md} (100%) rename doc/{sg/_index.md => contributing/style_guides/README.md} (100%) rename doc/{sg => contributing/style_guides}/asm_coding_style.md (100%) rename doc/{sg => contributing/style_guides}/c_cpp_coding_style.md (100%) rename doc/{sg => contributing/style_guides}/guidance_for_volatile.md (100%) rename doc/{sg => contributing/style_guides}/hjson_usage_style.md (100%) rename doc/{sg => contributing/style_guides}/markdown_usage_style.md (100%) rename doc/{sg => contributing/style_guides}/otbn_style_guide.md (100%) rename doc/{sg => contributing/style_guides}/python_coding_style.md (100%) rename doc/{rm => contributing/sw}/device_interface_functions.md (100%) rename doc/{ug => contributing/sw}/otbn_sw.md (100%) rename doc/{ug => contributing}/system_list.md (100%) rename doc/{getting_started/_index.md => guides/getting_started/src/README.md} (100%) rename doc/{ug/documentation.md => guides/getting_started/src/build_docs.md} (100%) rename doc/{getting_started => guides/getting_started/src}/build_sw.md (100%) rename doc/{getting_started => guides/getting_started/src}/getting_started_workflow.svg (100%) rename doc/{getting_started => guides/getting_started/src}/install_openocd.md (100%) rename doc/{getting_started/install_vivado/index.md => guides/getting_started/src/install_vivado/README.md} (100%) rename doc/{getting_started => guides/getting_started/src}/install_vivado/features.png (100%) rename doc/{getting_started => guides/getting_started/src}/setup_dv.md (100%) rename doc/{getting_started => guides/getting_started/src}/setup_formal.md (100%) rename doc/{getting_started => guides/getting_started/src}/setup_fpga.md (100%) rename doc/{getting_started => guides/getting_started/src}/setup_verilator.md (100%) delete mode 120000 doc/project/hw_checklist.md.tpl rename doc/{project/_index.md => project_governance/README.md} (100%) rename doc/{project/checklist.md => project_governance/checklist/README.md} (100%) create mode 120000 doc/project_governance/checklist/hw_checklist.md.tpl rename doc/{project => project_governance/checklist}/sw_checklist.md.tpl (100%) rename doc/{project => project_governance}/committers.md (100%) rename doc/{project => project_governance}/development_stages.md (100%) rename doc/{project => project_governance}/priority_definitions.md (100%) rename doc/{project => project_governance}/rfc_process.md (100%) rename doc/{project => project_governance}/technical_committee.md (100%) rename doc/{ug/rust_for_c.md => rust_for_c_devs.md} (100%) delete mode 100644 doc/ug/_index.md diff --git a/doc/_index.md b/doc/_index.md deleted file mode 100644 index daab8da108347..0000000000000 --- a/doc/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Documentation" ---- - -{{% sectionContent %}} diff --git a/doc/project/contributing.md b/doc/contributing/README.md similarity index 100% rename from doc/project/contributing.md rename to doc/contributing/README.md diff --git a/doc/ug/bazel_notes.md b/doc/contributing/bazel_notes.md similarity index 100% rename from doc/ug/bazel_notes.md rename to doc/contributing/bazel_notes.md diff --git a/doc/rm/continuous_integration/index.md b/doc/contributing/ci/README.md similarity index 100% rename from doc/rm/continuous_integration/index.md rename to doc/contributing/ci/README.md diff --git a/doc/rm/continuous_integration/continuous_integration_overview.svg b/doc/contributing/ci/continuous_integration_overview.svg similarity index 100% rename from doc/rm/continuous_integration/continuous_integration_overview.svg rename to doc/contributing/ci/continuous_integration_overview.svg diff --git a/doc/project/detailed_contribution_guide/_index.md b/doc/contributing/detailed_contribution_guide/README.md similarity index 100% rename from doc/project/detailed_contribution_guide/_index.md rename to doc/contributing/detailed_contribution_guide/README.md diff --git a/doc/project/detailed_contribution_guide/contributing_code_flow_chart.svg b/doc/contributing/detailed_contribution_guide/contributing_code_flow_chart.svg similarity index 100% rename from doc/project/detailed_contribution_guide/contributing_code_flow_chart.svg rename to doc/contributing/detailed_contribution_guide/contributing_code_flow_chart.svg diff --git a/doc/ug/directory_structure.md b/doc/contributing/directory_structure.md similarity index 100% rename from doc/ug/directory_structure.md rename to doc/contributing/directory_structure.md diff --git a/doc/ug/dv_methodology/index.md b/doc/contributing/dv/methodology/README.md similarity index 100% rename from doc/ug/dv_methodology/index.md rename to doc/contributing/dv/methodology/README.md diff --git a/doc/ug/dv_methodology/dv_method_multi_gate.svg b/doc/contributing/dv/methodology/dv_method_multi_gate.svg similarity index 100% rename from doc/ug/dv_methodology/dv_method_multi_gate.svg rename to doc/contributing/dv/methodology/dv_method_multi_gate.svg diff --git a/doc/ug/dv_methodology/dv_method_single_gate.svg b/doc/contributing/dv/methodology/dv_method_single_gate.svg similarity index 100% rename from doc/ug/dv_methodology/dv_method_single_gate.svg rename to doc/contributing/dv/methodology/dv_method_single_gate.svg diff --git a/doc/ug/sec_cm_dv_framework/index.md b/doc/contributing/dv/sec_cm_dv_framework/README.md similarity index 100% rename from doc/ug/sec_cm_dv_framework/index.md rename to doc/contributing/dv/sec_cm_dv_framework/README.md diff --git a/doc/ug/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg b/doc/contributing/dv/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg similarity index 100% rename from doc/ug/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg rename to doc/contributing/dv/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg diff --git a/doc/ug/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg b/doc/contributing/dv/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg similarity index 100% rename from doc/ug/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg rename to doc/contributing/dv/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg diff --git a/doc/ug/fpga_boards.md b/doc/contributing/fpga/get_a_board.md similarity index 100% rename from doc/ug/fpga_boards.md rename to doc/contributing/fpga/get_a_board.md diff --git a/doc/rm/ref_manual_fpga.md b/doc/contributing/fpga/ref_manual_fpga.md similarity index 100% rename from doc/rm/ref_manual_fpga.md rename to doc/contributing/fpga/ref_manual_fpga.md diff --git a/doc/ug/github_notes.md b/doc/contributing/github_notes.md similarity index 100% rename from doc/ug/github_notes.md rename to doc/contributing/github_notes.md diff --git a/doc/rm/comportability_specification/index.md b/doc/contributing/hw/comportability/README.md similarity index 100% rename from doc/rm/comportability_specification/index.md rename to doc/contributing/hw/comportability/README.md diff --git a/doc/rm/comportability_specification/comportability_diagram_intr_hw.svg b/doc/contributing/hw/comportability/comportability_diagram_intr_hw.svg similarity index 100% rename from doc/rm/comportability_specification/comportability_diagram_intr_hw.svg rename to doc/contributing/hw/comportability/comportability_diagram_intr_hw.svg diff --git a/doc/rm/comportability_specification/comportability_diagram_peripheral.svg b/doc/contributing/hw/comportability/comportability_diagram_peripheral.svg similarity index 100% rename from doc/rm/comportability_specification/comportability_diagram_peripheral.svg rename to doc/contributing/hw/comportability/comportability_diagram_peripheral.svg diff --git a/doc/ug/hw_design.md b/doc/contributing/hw/design.md similarity index 100% rename from doc/ug/hw_design.md rename to doc/contributing/hw/design.md diff --git a/doc/ug/design.md b/doc/contributing/hw/methodology.md similarity index 100% rename from doc/ug/design.md rename to doc/contributing/hw/methodology.md diff --git a/doc/ug/vendor_hw.md b/doc/contributing/hw/vendor.md similarity index 100% rename from doc/ug/vendor_hw.md rename to doc/contributing/hw/vendor.md diff --git a/doc/sg/_index.md b/doc/contributing/style_guides/README.md similarity index 100% rename from doc/sg/_index.md rename to doc/contributing/style_guides/README.md diff --git a/doc/sg/asm_coding_style.md b/doc/contributing/style_guides/asm_coding_style.md similarity index 100% rename from doc/sg/asm_coding_style.md rename to doc/contributing/style_guides/asm_coding_style.md diff --git a/doc/sg/c_cpp_coding_style.md b/doc/contributing/style_guides/c_cpp_coding_style.md similarity index 100% rename from doc/sg/c_cpp_coding_style.md rename to doc/contributing/style_guides/c_cpp_coding_style.md diff --git a/doc/sg/guidance_for_volatile.md b/doc/contributing/style_guides/guidance_for_volatile.md similarity index 100% rename from doc/sg/guidance_for_volatile.md rename to doc/contributing/style_guides/guidance_for_volatile.md diff --git a/doc/sg/hjson_usage_style.md b/doc/contributing/style_guides/hjson_usage_style.md similarity index 100% rename from doc/sg/hjson_usage_style.md rename to doc/contributing/style_guides/hjson_usage_style.md diff --git a/doc/sg/markdown_usage_style.md b/doc/contributing/style_guides/markdown_usage_style.md similarity index 100% rename from doc/sg/markdown_usage_style.md rename to doc/contributing/style_guides/markdown_usage_style.md diff --git a/doc/sg/otbn_style_guide.md b/doc/contributing/style_guides/otbn_style_guide.md similarity index 100% rename from doc/sg/otbn_style_guide.md rename to doc/contributing/style_guides/otbn_style_guide.md diff --git a/doc/sg/python_coding_style.md b/doc/contributing/style_guides/python_coding_style.md similarity index 100% rename from doc/sg/python_coding_style.md rename to doc/contributing/style_guides/python_coding_style.md diff --git a/doc/rm/device_interface_functions.md b/doc/contributing/sw/device_interface_functions.md similarity index 100% rename from doc/rm/device_interface_functions.md rename to doc/contributing/sw/device_interface_functions.md diff --git a/doc/ug/otbn_sw.md b/doc/contributing/sw/otbn_sw.md similarity index 100% rename from doc/ug/otbn_sw.md rename to doc/contributing/sw/otbn_sw.md diff --git a/doc/ug/system_list.md b/doc/contributing/system_list.md similarity index 100% rename from doc/ug/system_list.md rename to doc/contributing/system_list.md diff --git a/doc/getting_started/_index.md b/doc/guides/getting_started/src/README.md similarity index 100% rename from doc/getting_started/_index.md rename to doc/guides/getting_started/src/README.md diff --git a/doc/ug/documentation.md b/doc/guides/getting_started/src/build_docs.md similarity index 100% rename from doc/ug/documentation.md rename to doc/guides/getting_started/src/build_docs.md diff --git a/doc/getting_started/build_sw.md b/doc/guides/getting_started/src/build_sw.md similarity index 100% rename from doc/getting_started/build_sw.md rename to doc/guides/getting_started/src/build_sw.md diff --git a/doc/getting_started/getting_started_workflow.svg b/doc/guides/getting_started/src/getting_started_workflow.svg similarity index 100% rename from doc/getting_started/getting_started_workflow.svg rename to doc/guides/getting_started/src/getting_started_workflow.svg diff --git a/doc/getting_started/install_openocd.md b/doc/guides/getting_started/src/install_openocd.md similarity index 100% rename from doc/getting_started/install_openocd.md rename to doc/guides/getting_started/src/install_openocd.md diff --git a/doc/getting_started/install_vivado/index.md b/doc/guides/getting_started/src/install_vivado/README.md similarity index 100% rename from doc/getting_started/install_vivado/index.md rename to doc/guides/getting_started/src/install_vivado/README.md diff --git a/doc/getting_started/install_vivado/features.png b/doc/guides/getting_started/src/install_vivado/features.png similarity index 100% rename from doc/getting_started/install_vivado/features.png rename to doc/guides/getting_started/src/install_vivado/features.png diff --git a/doc/getting_started/setup_dv.md b/doc/guides/getting_started/src/setup_dv.md similarity index 100% rename from doc/getting_started/setup_dv.md rename to doc/guides/getting_started/src/setup_dv.md diff --git a/doc/getting_started/setup_formal.md b/doc/guides/getting_started/src/setup_formal.md similarity index 100% rename from doc/getting_started/setup_formal.md rename to doc/guides/getting_started/src/setup_formal.md diff --git a/doc/getting_started/setup_fpga.md b/doc/guides/getting_started/src/setup_fpga.md similarity index 100% rename from doc/getting_started/setup_fpga.md rename to doc/guides/getting_started/src/setup_fpga.md diff --git a/doc/getting_started/setup_verilator.md b/doc/guides/getting_started/src/setup_verilator.md similarity index 100% rename from doc/getting_started/setup_verilator.md rename to doc/guides/getting_started/src/setup_verilator.md diff --git a/doc/project/hw_checklist.md.tpl b/doc/project/hw_checklist.md.tpl deleted file mode 120000 index b6b34158e5f59..0000000000000 --- a/doc/project/hw_checklist.md.tpl +++ /dev/null @@ -1 +0,0 @@ -../../util/uvmdvgen/checklist.md.tpl \ No newline at end of file diff --git a/doc/project/_index.md b/doc/project_governance/README.md similarity index 100% rename from doc/project/_index.md rename to doc/project_governance/README.md diff --git a/doc/project/checklist.md b/doc/project_governance/checklist/README.md similarity index 100% rename from doc/project/checklist.md rename to doc/project_governance/checklist/README.md diff --git a/doc/project_governance/checklist/hw_checklist.md.tpl b/doc/project_governance/checklist/hw_checklist.md.tpl new file mode 120000 index 0000000000000..1d5eee0be3b0b --- /dev/null +++ b/doc/project_governance/checklist/hw_checklist.md.tpl @@ -0,0 +1 @@ +../../../util/uvmdvgen/checklist.md.tpl \ No newline at end of file diff --git a/doc/project/sw_checklist.md.tpl b/doc/project_governance/checklist/sw_checklist.md.tpl similarity index 100% rename from doc/project/sw_checklist.md.tpl rename to doc/project_governance/checklist/sw_checklist.md.tpl diff --git a/doc/project/committers.md b/doc/project_governance/committers.md similarity index 100% rename from doc/project/committers.md rename to doc/project_governance/committers.md diff --git a/doc/project/development_stages.md b/doc/project_governance/development_stages.md similarity index 100% rename from doc/project/development_stages.md rename to doc/project_governance/development_stages.md diff --git a/doc/project/priority_definitions.md b/doc/project_governance/priority_definitions.md similarity index 100% rename from doc/project/priority_definitions.md rename to doc/project_governance/priority_definitions.md diff --git a/doc/project/rfc_process.md b/doc/project_governance/rfc_process.md similarity index 100% rename from doc/project/rfc_process.md rename to doc/project_governance/rfc_process.md diff --git a/doc/project/technical_committee.md b/doc/project_governance/technical_committee.md similarity index 100% rename from doc/project/technical_committee.md rename to doc/project_governance/technical_committee.md diff --git a/doc/ug/rust_for_c.md b/doc/rust_for_c_devs.md similarity index 100% rename from doc/ug/rust_for_c.md rename to doc/rust_for_c_devs.md diff --git a/doc/ug/_index.md b/doc/ug/_index.md deleted file mode 100644 index cfffe770d4cd3..0000000000000 --- a/doc/ug/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "User Guides" ---- - -{{% sectionContent %}}