Commit 4e3c47bf authored by David Vincze's avatar David Vincze Committed by David Brown
Browse files

docs: Fix Markdown rendering issues 



- Fix rendering issues of multi-line HTML comments (license headers)
- Fix rendering issues of footnotes

Change-Id: I06c8ad3454a62187e9d527df62560b897ec478f4
Signed-off-by: default avatarDavid Vincze <david.vincze@linaro.org>
parent e3cbbece

docs/PORTING.md

+2 −2
Original line number Diff line number Diff line
@@ -144,7 +144,7 @@ int flash_area_id_to_multi_image_slot(int image_index, int area_id); 
needs to provide this pair of function.



To configure the what functions are called when allocating/deallocating

memory `mbed TLS` uses the following call [^cite1]:

memory `mbed TLS` uses the following call [^1]:



```

int mbedtls_platform_set_calloc_free (void *(*calloc_func)(size_t, size_t),
@@ -155,4 +155,4 @@ If your system already provides functions with compatible signatures, those 
can be used directly here, otherwise create new functions that glue to

your `calloc/free` implementations.



[^cite1]```https://tls.mbed.org/api/platform_8h.html```
 
[^1]: ```https://tls.mbed.org/api/platform_8h.html```

docs/design.md

+19 −17
Original line number Diff line number Diff line 
<!--

  Licensed to the Apache Software Foundation (ASF) under one

  or more contributor license agreements.  See the NOTICE file

  distributed with this work for additional information

  regarding copyright ownership.  The ASF licenses this file

  to you under the Apache License, Version 2.0 (the

  "License"); you may not use this file except in compliance

  with the License.  You may obtain a copy of the License at



   http://www.apache.org/licenses/LICENSE-2.0



  Unless required by applicable law or agreed to in writing,

  software distributed under the License is distributed on an

  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

  KIND, either express or implied.  See the License for the

  specific language governing permissions and limitations

  under the License.

    -

    - Licensed to the Apache Software Foundation (ASF) under one

    - or more contributor license agreements.  See the NOTICE file

    - distributed with this work for additional information

    - regarding copyright ownership.  The ASF licenses this file

    - to you under the Apache License, Version 2.0 (the

    - "License"); you may not use this file except in compliance

    - with the License.  You may obtain a copy of the License at

    -

    -  http://www.apache.org/licenses/LICENSE-2.0

    -

    - Unless required by applicable law or agreed to in writing,

    - software distributed under the License is distributed on an

    - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

    - KIND, either express or implied.  See the License for the

    - specific language governing permissions and limitations

    - under the License.

    -

-->



<!--

  Modifications are Copyright (c) 2019-2020 Arm Limited.

    - Modifications are Copyright (c) 2019-2020 Arm Limited.

-->



# Boot Loader

docs/encrypted_images.md

+18 −18
Original line number Diff line number Diff line 
<!--

#

# Licensed to the Apache Software Foundation (ASF) under one

# or more contributor license agreements.  See the NOTICE file

# distributed with this work for additional information

# regarding copyright ownership.  The ASF licenses this file

# to you under the Apache License, Version 2.0 (the

# "License"); you may not use this file except in compliance

# with the License.  You may obtain a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing,

# software distributed under the License is distributed on an

# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

#  KIND, either express or implied.  See the License for the

# specific language governing permissions and limitations

# under the License.

#

    -

    - Licensed to the Apache Software Foundation (ASF) under one

    - or more contributor license agreements.  See the NOTICE file

    - distributed with this work for additional information

    - regarding copyright ownership.  The ASF licenses this file

    - to you under the Apache License, Version 2.0 (the

    - "License"); you may not use this file except in compliance

    - with the License.  You may obtain a copy of the License at

    -

    -  http://www.apache.org/licenses/LICENSE-2.0

    -

    - Unless required by applicable law or agreed to in writing,

    - software distributed under the License is distributed on an

    - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

    - KIND, either express or implied.  See the License for the

    - specific language governing permissions and limitations

    - under the License.

    -

-->



# Encrypted images

docs/signed_images.md

+18 −18
Original line number Diff line number Diff line 
<!--

#

# Licensed to the Apache Software Foundation (ASF) under one

# or more contributor license agreements.  See the NOTICE file

# distributed with this work for additional information

# regarding copyright ownership.  The ASF licenses this file

# to you under the Apache License, Version 2.0 (the

# "License"); you may not use this file except in compliance

# with the License.  You may obtain a copy of the License at

#

# http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing,

# software distributed under the License is distributed on an

# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

#  KIND, either express or implied.  See the License for the

# specific language governing permissions and limitations

# under the License.

#

    -

    - Licensed to the Apache Software Foundation (ASF) under one

    - or more contributor license agreements.  See the NOTICE file

    - distributed with this work for additional information

    - regarding copyright ownership.  The ASF licenses this file

    - to you under the Apache License, Version 2.0 (the

    - "License"); you may not use this file except in compliance

    - with the License.  You may obtain a copy of the License at

    -

    -  http://www.apache.org/licenses/LICENSE-2.0

    -

    - Unless required by applicable law or agreed to in writing,

    - software distributed under the License is distributed on an

    - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY

    - KIND, either express or implied.  See the License for the

    - specific language governing permissions and limitations

    - under the License.

    -

-->



## Image signing

CRA Git | Maintained and supported by SUSTech CRA and CCSE