/ scripts / globalizeIncludes
globalizeIncludes
 1  #!/bin/sh
 2  #
 3  # Copyright (c) 2019 The Khronos Group Inc.
 4  #
 5  # Licensed under the Apache License, Version 2.0 (the "License");
 6  # you may not use this file except in compliance with the License.
 7  # You may obtain a copy of the License at
 8  #
 9  #     http://www.apache.org/licenses/LICENSE-2.0
10  #
11  # Unless required by applicable law or agreed to in writing, software
12  # distributed under the License is distributed on an "AS IS" BASIS,
13  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  # See the License for the specific language governing permissions and
15  # limitations under the License.
16  
17  # globalizeIncludes - rewrites generated include::, and image:/image::
18  # asciidoctor directives in specified Vulkan specification source files to
19  # be relative to specified attributes {generated} and {images}, ensuring
20  # they work properly when extracted to reference pages.
21  #
22  # usage: globalizeIncludes filenames
23  # Updates specified files in-place, so make sure they're backed up first.
24  
25  sed -i -E \
26      -e 's#image:images/#image:{images}/#g' \
27      -e 's#image::images/#image::{images}/#g' \
28      -e 's#include::(\.\./)*(api|validity|hostsynctable)#include::{generated}/\2#g' \
29      $*
30  
31  # Not yet:
32  #   -e 's#include::meta/#include::{generated}/meta/#g' \