Skip to content

Commit 30f4d75

Browse files
author
pascalgouedo
authored
Merge pull request #979 from pascalgouedo/dev_dd_pgo_doc
User Manual improvements.
2 parents c9a2279 + 2b3c047 commit 30f4d75

20 files changed

+168
-148
lines changed

Diff for: ‎docs/images/openhw-landscape.png

25.5 KB
Loading

Diff for: ‎docs/source/conf.py

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
# -*- coding: utf-8 -*-
22
#
3-
# Copyright (c) 2020 OpenHW Group
4-
#
5-
# Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
6-
# you may not use this file except in compliance with the License.
3+
# Copyright 2024 OpenHW Group and Dolphin Design
4+
# SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
5+
#
6+
# Licensed under the Solderpad Hardware License v 2.1 (the "License");
7+
# you may not use this file except in compliance with the License, or,
8+
# at your option, the Apache License version 2.0.
79
# You may obtain a copy of the License at
810
#
9-
# https://solderpad.org/licenses/
11+
# https://solderpad.org/licenses/SHL-2.1/
1012
#
11-
# Unless required by applicable law or agreed to in writing, software
13+
# Unless required by applicable law or agreed to in writing, any work
1214
# distributed under the License is distributed on an "AS IS" BASIS,
1315
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1416
# See the License for the specific language governing permissions and
1517
# limitations under the License.
16-
#
17-
# SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1818
#
1919
###############################################################################
2020
#
@@ -44,7 +44,7 @@
4444
# The short X.Y version
4545
version = u''
4646
# The full version, including alpha/beta/rc tags
47-
release = u''
47+
release = u'v1.7.1'
4848

4949

5050
# -- General configuration ---------------------------------------------------
@@ -148,6 +148,8 @@
148148

149149
# -- Options for LaTeX output ------------------------------------------------
150150

151+
latex_logo = '../images/openhw-landscape.png'
152+
151153
latex_elements = {
152154
# The paper size ('letterpaper' or 'a4paper').
153155
#

Diff for: ‎docs/source/control_status_registers.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
7-
8-
https://solderpad.org/licenses/
9-
10-
Unless required by applicable law or agreed to in writing, software
9+
10+
https://solderpad.org/licenses/SHL-2.1/
11+
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
1517
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
17-
1818
.. _cs-registers:
1919

2020
Control and Status Registers

Diff for: ‎docs/source/core_versions.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2020 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _core_versions:
1919

Diff for: ‎docs/source/corev_hw_loop.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _hwloop-specs:
1919

Diff for: ‎docs/source/debug.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _debug-support:
1919

Diff for: ‎docs/source/exceptions_interrupts.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _exceptions-interrupts:
1919

Diff for: ‎docs/source/fpu.rst

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
1617
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1718
1819
.. _fpu:

Diff for: ‎docs/source/glossary.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2020 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _glossary:
1919

Diff for: ‎docs/source/index.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
OpenHW Group CV32E40P User Manual
1919
=================================

Diff for: ‎docs/source/instruction_fetch.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _instruction-fetch:
1919

Diff for: ‎docs/source/instruction_set_extensions.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _custom-isa-extensions:
1919

Diff for: ‎docs/source/integration.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
79
8-
https://solderpad.org/licenses/
10+
https://solderpad.org/licenses/SHL-2.1/
911
10-
Unless required by applicable law or agreed to in writing, software
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
15-
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
1717
1818
.. _core-integration:
1919

Diff for: ‎docs/source/intro.rst

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
..
2-
Copyright (c) 2023 OpenHW Group
3-
4-
Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License");
5-
you may not use this file except in compliance with the License.
2+
Copyright 2024 OpenHW Group and Dolphin Design
3+
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1
4+
5+
Licensed under the Solderpad Hardware License v 2.1 (the "License");
6+
you may not use this file except in compliance with the License, or,
7+
at your option, the Apache License version 2.0.
68
You may obtain a copy of the License at
7-
8-
https://solderpad.org/licenses/
9-
10-
Unless required by applicable law or agreed to in writing, software
9+
10+
https://solderpad.org/licenses/SHL-2.1/
11+
12+
Unless required by applicable law or agreed to in writing, any work
1113
distributed under the License is distributed on an "AS IS" BASIS,
1214
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1315
See the License for the specific language governing permissions and
1416
limitations under the License.
1517
16-
SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0
17-
1818
Introduction
1919
=============
2020

0 commit comments

Comments
 (0)