GNOME.org
 

[pitivi] docs: Fix some links and avoid inline code for code blocks

commit b00cee2860d5b10428d19af34b6ae227070ae466
Author: Thibault Saunier <tsaunier gnome org>
Date:   Thu Mar 23 18:13:36 2017 -0300

    docs: Fix some links and avoid inline code for code blocks

 docs/Bug_reporting.md                              |   49 ++++++++++++++------
 docs/Google_Summer_of_Code.md                      |    2 +-
 .../2008_design/2008_Architectural_Redesign.md     |    2 +-
 docs/design/UI_Implementation.md                   |    3 -
 docs/design/UI_components.md                       |    5 +-
 docs/releases/0.91.md                              |    2 +-
 docs/releases/0.92.md                              |    2 +-
 docs/releases/0.93.md                              |    2 +-
 docs/releases/0.94.md                              |    2 +-
 docs/releases/0.95.md                              |    2 +-
 docs/releases/0.96.md                              |    2 +-
 docs/releases/0.97.md                              |    2 +-
 docs/sitemap.txt                                   |    2 +-
 13 files changed, 47 insertions(+), 30 deletions(-)
---
diff --git a/docs/Bug_reporting.md b/docs/Bug_reporting.md
index 7f4f331..2bb5cd9 100644
--- a/docs/Bug_reporting.md
+++ b/docs/Bug_reporting.md
@@ -94,11 +94,15 @@ flatpak install --user $GNOME_REPO org.gnome.Sdk.Debug 3.22
 
 Start a shell in the Pitivi bundle environment
 
-`flatpak run -d --command=bash org.pitivi.Pitivi`
+```
+flatpak run -d --command=bash org.pitivi.Pitivi
+```
 
 Start Pitivi inside gdb
 
-`gdb python3 -ex 'run /app/bin/pitivi`'
+```
+gdb python3 -ex 'run /app/bin/pitivi
+```
 
 When Pitivi crashes, run `bt full` to get the backtrace. When Pitivi
 freezes, press Ctrl+Z and run `thread apply all bt` to get the
@@ -118,14 +122,17 @@ commands that can be particularly useful in Pitivi's context.
 When you want to “attach” to an existing Python process (useful for
 deadlocks, where the application will be hung instead of crashed):
 
-`gdb python3 THE_PITIVI_PROCESS_NUMBER`
+```
+gdb python3 THE_PITIVI_PROCESS_NUMBER
+```
 
 When you want to run Pitivi entirely in gdb from the start:
 
-`gdb python3`\
-`set pagination 0  # avoids the need to press Enter to “scroll”`
-
-`run /usr/bin/pitivi  # the version installed system-wide`
+```
+gdb python3 $(which pitivi)
+set pagination 0  # avoids the need to press Enter to “scroll”
+run
+```
 
 When Pitivi crashes, run `bt full` to get the backtrace. When Pitivi
 freezes, press Ctrl+Z and run `thread apply all bt` to get the
@@ -144,17 +151,23 @@ there are five levels: ( <span style="color:red;">ERROR</span>,
 <span style="color:cyan;">LOG</span> ) = range(1, 7). As such, if you
 want to see errors and warnings only, you launch
 
-`PITIVI_DEBUG=2 bin/pitivi`
+```
+PITIVI_DEBUG=2 bin/pitivi
+```
 
 ...and if you want to see everything you do
 
-`PITIVI_DEBUG=6 bin/pitivi`
+```
+PITIVI_DEBUG=6 bin/pitivi
+```
 
 If that's “too much” and you want to focus on particular parts of the
 code, you can do so. For example, you can get output from the `Timeline`
 and `MediaLibraryWidget` classes only:
 
-`PITIVI_DEBUG=`**`timeline`**`:6,`**`medialibrarywidget`**`:6 bin/pitivi`
+```
+PITIVI_DEBUG=timeline:6,medialibrarywidget:6 bin/pitivi
+```
 
 Here are various examples of commands you can use to generate detailed
 debug logs that include not only Pitivi's debug output, but also
@@ -162,16 +175,22 @@ GStreamer's:
 
 A basic log can be obtained by running:
 
-`PITIVI_DEBUG=*:5 GST_DEBUG=2 bin/pitivi > debug.log 2>&1`
+```
+PITIVI_DEBUG=*:5 GST_DEBUG=2 bin/pitivi > debug.log 2>&1
+```
 
 To get debugging information from Non-Linear Engine, you could use:
 
-`PITIVI_DEBUG=5 GST_DEBUG=3,nle*:5,python:5 bin/pitivi > debug.log 2>&1`
+```
+PITIVI_DEBUG=5 GST_DEBUG=3,nle*:5,python:5 bin/pitivi > debug.log 2>&1
+```
 
 The information most likely to be useful would probably be the debug
 info from [GES](GES.md) in addition to Pitivi's:
 
-`PITIVI_DEBUG=5 GST_DEBUG=ges:5 bin/pitivi > debug.log 2>&1;`
+```
+PITIVI_DEBUG=5 GST_DEBUG=ges:5 bin/pitivi > debug.log 2>&1;
+```
 
 Some additional tips:
 
@@ -188,7 +207,9 @@ you can profile Pitivi itself, with this command (and yes,
 variable of
 [bin/pitivi](https://git.gnome.org/browse/pitivi/tree/bin/pitivi.in):
 
-`JUMP_THROUGH_HOOPS=1 python3 -m cProfile -s time -o pitivi_performance.profile bin/pitivi`
+```
+JUMP_THROUGH_HOOPS=1 python3 -m cProfile -s time -o pitivi_performance.profile bin/pitivi
+```
 
 The resulting `pitivi_performance.profile` file can then be processed
 to create a visual representation of where the most time was spent and
diff --git a/docs/Google_Summer_of_Code.md b/docs/Google_Summer_of_Code.md
index e8c0f8a..e9a9809 100644
--- a/docs/Google_Summer_of_Code.md
+++ b/docs/Google_Summer_of_Code.md
@@ -161,5 +161,5 @@ See [Past GSoCs] for details on what the previous GSoC students did.
   [GES]: GES.md
   [Pitivi]: http://www.pitivi.org/manual/mainwindow.html
   [Pitivi tasks for newcomers]: https://phabricator.freedesktop.org/tag/pitivi_tasks_for_newcomers/
-  [roadmap]: roadmap.md
+  [roadmap]: Roadmap.md
   [Past GSoCs]: Past_GSoCs.md
diff --git a/docs/design/2008_design/2008_Architectural_Redesign.md 
b/docs/design/2008_design/2008_Architectural_Redesign.md
index 1f48a85..412751b 100644
--- a/docs/design/2008_design/2008_Architectural_Redesign.md
+++ b/docs/design/2008_design/2008_Architectural_Redesign.md
@@ -39,7 +39,7 @@ The following documents are supposed to be read in order:
 
 Yet more historical pages that predated this redesign initiative:
 
--   [UI Implementation](UI_Implementation.md)
+-   [UI Implementation](design/UI_Implementation.md)
 -   [Multi-Layer Editing](Multi-Layer_Editing.md)
 -   [Plugins](Plugins.md)
 -   [2008 Plugin Interface
diff --git a/docs/design/UI_Implementation.md b/docs/design/UI_Implementation.md
index c5bdd2f..34b5638 100644
--- a/docs/design/UI_Implementation.md
+++ b/docs/design/UI_Implementation.md
@@ -1,8 +1,5 @@
 # UI Implementation
 
-For the previous design document, see [Obsolete: Advanced UI
-Implementation](Obsolete:_Advanced_UI_Implementation.md)
-
 This document **does not reflect the existing codebase**, but rather a
 road map for future development, and a general introduction to the
 PiTiVi design philosophy.
diff --git a/docs/design/UI_components.md b/docs/design/UI_components.md
index 2965688..381d10c 100644
--- a/docs/design/UI_components.md
+++ b/docs/design/UI_components.md
@@ -3,6 +3,5 @@
 These documents describe the appearance and implementation of PiTiVi's
 user interface. Pages linked here can only be “actual” stuff.
 
--   [UI Implementation](UI_Implementation.md)
--   [Compositing Interface](Compositing_Interface.md)
--   [Compositing Subinterface](Compositing.md) (needs work)
+-   [UI Implementation](design/UI_Implementation.md)
+* FIXME!
diff --git a/docs/releases/0.91.md b/docs/releases/0.91.md
index df9e995..8505689 100644
--- a/docs/releases/0.91.md
+++ b/docs/releases/0.91.md
@@ -215,7 +215,7 @@ Soft requirements:
 -   pycanberra (static bindings)
 -   frei0r
 
-See also [dependencies](Dependencies.md) for additional tips.
+See also [dependencies](attic/Dependencies.md) for additional tips.
 
 ## Known issues
 
diff --git a/docs/releases/0.92.md b/docs/releases/0.92.md
index e2f3d09..36d429a 100644
--- a/docs/releases/0.92.md
+++ b/docs/releases/0.92.md
@@ -66,7 +66,7 @@ series, but have stayed mostly the same since [0.91](releases/0.91.md)
 
 Generally speaking, you can refer to Pitivi's check.py for the
 dependencies' versions specific to a given release. See also
-[dependencies](Dependencies.md) for additional tips.
+[dependencies](attic/Dependencies.md) for additional tips.
 
 ## Known issues
 
diff --git a/docs/releases/0.93.md b/docs/releases/0.93.md
index 19b253f..46e4c2f 100644
--- a/docs/releases/0.93.md
+++ b/docs/releases/0.93.md
@@ -140,7 +140,7 @@ For this release, we depend on GStreamer, GNonLin and GES 1.2.
 
 Generally speaking, you can refer to Pitivi's check.py for the
 dependencies' versions specific to a given release. See also
-[dependencies](Dependencies.md) for additional tips.
+[dependencies](attic/Dependencies.md) for additional tips.
 
 ## Known issues
 
diff --git a/docs/releases/0.94.md b/docs/releases/0.94.md
index e3c2b01..c7f6724 100644
--- a/docs/releases/0.94.md
+++ b/docs/releases/0.94.md
@@ -109,7 +109,7 @@ In this release:
 
 Generally speaking, you can refer to Pitivi's check.py for the
 dependencies' versions specific to a given release. See also
-[dependencies](Dependencies.md) for additional tips.
+[dependencies](attic/Dependencies.md) for additional tips.
 
 ## Known issues
 
diff --git a/docs/releases/0.95.md b/docs/releases/0.95.md
index 817407e..937f4f3 100644
--- a/docs/releases/0.95.md
+++ b/docs/releases/0.95.md
@@ -77,7 +77,7 @@ UI when running on small screens.
 
 Generally speaking, you can refer to the bottom of Pitivi's check.py for
 the dependencies' versions specific to a given release. See also
-[dependencies](Dependencies.md) for additional tips.
+[dependencies](attic/Dependencies.md) for additional tips.
 
 ## Known issues
 
diff --git a/docs/releases/0.96.md b/docs/releases/0.96.md
index 59e1b17..4994ed2 100644
--- a/docs/releases/0.96.md
+++ b/docs/releases/0.96.md
@@ -40,7 +40,7 @@ Pitivi, fixing many bugs and implementing the following features:
 
 Generally speaking, you can refer to the bottom of Pitivi's check.py for
 the dependencies' versions specific to a given release. See also
-[dependencies](Dependencies.md) for additional tips.
+[dependencies](attic/Dependencies.md) for additional tips.
 
 ## Known issues
 
diff --git a/docs/releases/0.97.md b/docs/releases/0.97.md
index 627205c..aa1af2c 100644
--- a/docs/releases/0.97.md
+++ b/docs/releases/0.97.md
@@ -35,7 +35,7 @@ Pitivi, fixing many bugs and implementing the following features:
 
 Generally speaking, you can refer to the bottom of Pitivi's check.py for
 the dependencies' versions specific to a given release. See also
-[dependencies](Dependencies.md) for additional tips.
+[dependencies](attic/Dependencies.md) for additional tips.
 
 ## Known issues
 
diff --git a/docs/sitemap.txt b/docs/sitemap.txt
index fc8435c..1ba6561 100644
--- a/docs/sitemap.txt
+++ b/docs/sitemap.txt
@@ -1,4 +1,4 @@
-Main_Page.md
+index.md
        Install_with_flatpak.md
        Bug_reporting.md
        HACKING.md
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]