From 5f10313f782eca4370f69658596538cb6e47f03f Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Sep 29 2018 07:47:26 +0000 Subject: Add titles to all language-specific pages. --- diff --git a/guidelines/modules/ROOT/pages/Ada.adoc b/guidelines/modules/ROOT/pages/Ada.adoc index dc0e3fc..1154a7d 100644 --- a/guidelines/modules/ROOT/pages/Ada.adoc +++ b/guidelines/modules/ROOT/pages/Ada.adoc @@ -1,4 +1,4 @@ -= Packaging Ada programs and libraries += Ada Packaging Guidelines This document describes the current policies for packaging Ada programs and libraries for Fedora. These are Ada-specific amendments to the generic Packaging Guidelines. Ada packages must also conform to the Packaging:Guidelines[Packaging Guidelines] and the Packaging:ReviewGuidelines[Review Guidelines]. diff --git a/guidelines/modules/ROOT/pages/C_and_C++.adoc b/guidelines/modules/ROOT/pages/C_and_C++.adoc index 2ef002b..3ebd12a 100644 --- a/guidelines/modules/ROOT/pages/C_and_C++.adoc +++ b/guidelines/modules/ROOT/pages/C_and_C++.adoc @@ -1,4 +1,4 @@ -= C and C++ += C and C++ Packaging Guidelines // https://github.com/asciidoctor/asciidoctor/commit/426d8389aa1706a589b66c96801542f587ae6b61 :pp: ++ diff --git a/guidelines/modules/ROOT/pages/D.adoc b/guidelines/modules/ROOT/pages/D.adoc index 122ed55..a3afd1f 100644 --- a/guidelines/modules/ROOT/pages/D.adoc +++ b/guidelines/modules/ROOT/pages/D.adoc @@ -1,3 +1,5 @@ += D Packaging Guidelines + == ldc All D packages depend on ldc to build, so every package must have ldc as BuildRequires. In addition, the ldc package includes some useful macros for D packages. diff --git a/guidelines/modules/ROOT/pages/Fortran.adoc b/guidelines/modules/ROOT/pages/Fortran.adoc index cd84dd6..50886ea 100644 --- a/guidelines/modules/ROOT/pages/Fortran.adoc +++ b/guidelines/modules/ROOT/pages/Fortran.adoc @@ -1,3 +1,5 @@ += Fortran Packaging Guidelines + == Modules and include files The fortran modules files, ending in .mod are files describing a fortran 90 (and above) module API and ABI. These are not like C header files describing an API, they are compiler dependent and arch dependent, and not easily readable by a human being. They are nevertheless searched for in the includes directories by gfortran (in directories specified with `+-I+`). diff --git a/guidelines/modules/ROOT/pages/Java.adoc b/guidelines/modules/ROOT/pages/Java.adoc index 04cfeee..f3e80bb 100644 --- a/guidelines/modules/ROOT/pages/Java.adoc +++ b/guidelines/modules/ROOT/pages/Java.adoc @@ -1,3 +1,5 @@ += Java Packaging Guidelines + __TOC__ This page represents Fedora guidelines for packaging libraries and applications written in Java and related languages using Java Virtual Machine as bytecode interpreter. It does not aim to extensively describe packaging techniques and tips. RPM macros and commands used here are documented in man pages. Furthermore a separate https://fedora-java.github.io/howto/latest/[Java Packaging HOWTO] describes Java packaging techniques in detail and includes examples, templates and documentation aimed at packagers and Java developers who are taking their first steps in Java RPM packaging. diff --git a/guidelines/modules/ROOT/pages/JavaScript.adoc b/guidelines/modules/ROOT/pages/JavaScript.adoc index f7a9d70..8e624b8 100644 --- a/guidelines/modules/ROOT/pages/JavaScript.adoc +++ b/guidelines/modules/ROOT/pages/JavaScript.adoc @@ -1,3 +1,5 @@ += JavaScript Packaging Guidelines + == Overview JavaScript code used for the web needs special consideration to ensure that it meets the high standards expected of all code shipped by Fedora, while still being useful and complying with conventions already used on millions of websites. Additionally, certain libraries typically used on the web can also be useful in a server-side context (by nodejs or rubygem-execjs), so it's important to package JavaScript so it meets the standards required of locally executed code as well. diff --git a/guidelines/modules/ROOT/pages/Lisp.adoc b/guidelines/modules/ROOT/pages/Lisp.adoc index 356e7a2..a6c1744 100644 --- a/guidelines/modules/ROOT/pages/Lisp.adoc +++ b/guidelines/modules/ROOT/pages/Lisp.adoc @@ -1,4 +1,4 @@ -== Lisp Packaging Guidelines += Lisp Packaging Guidelines This document seeks to document the conventions and customs surrounding the proper packaging of Common Lisp implementations and libraries in Fedora. This document does _not_ describe conventions and customs for application programs that are written in Common Lisp. diff --git a/guidelines/modules/ROOT/pages/Mono.adoc b/guidelines/modules/ROOT/pages/Mono.adoc index c3b39e8..04ddd39 100644 --- a/guidelines/modules/ROOT/pages/Mono.adoc +++ b/guidelines/modules/ROOT/pages/Mono.adoc @@ -1,3 +1,5 @@ += Mono Packaging Guidelines + __TOC__ == File Locations and Architectures diff --git a/guidelines/modules/ROOT/pages/Node.js.adoc b/guidelines/modules/ROOT/pages/Node.js.adoc index ee2c8be..567a17e 100644 --- a/guidelines/modules/ROOT/pages/Node.js.adoc +++ b/guidelines/modules/ROOT/pages/Node.js.adoc @@ -1,3 +1,5 @@ += Node.js Packaging Guidelines + == Naming Guidelines * The name of a Node.js extension/library package must start with _nodejs-_ then the upstream name or name used in the npm registry. For example: _nodejs-foomodule_. While it is uncommon for a package's name to contain _node_, if it does, you should still add the nodejs prefix. For instance, the npm registry contains a _uuid_ and a _node-uuid_ module, which would need to be named _nodejs-uuid_ and _nodejs-node-uuid_, repsectively. diff --git a/guidelines/modules/ROOT/pages/OCaml.adoc b/guidelines/modules/ROOT/pages/OCaml.adoc index ac565f9..d8e603a 100644 --- a/guidelines/modules/ROOT/pages/OCaml.adoc +++ b/guidelines/modules/ROOT/pages/OCaml.adoc @@ -1,3 +1,5 @@ += OCaml Packaging Guidelines + This document seeks to document the conventions and customs surrounding the proper packaging of ocaml modules in Fedora. It does not intend to cover all situations, but to codify those practices which have served the Fedora ocaml community well. == Naming diff --git a/guidelines/modules/ROOT/pages/Octave.adoc b/guidelines/modules/ROOT/pages/Octave.adoc index a4c408c..ae4ee7c 100644 --- a/guidelines/modules/ROOT/pages/Octave.adoc +++ b/guidelines/modules/ROOT/pages/Octave.adoc @@ -1,4 +1,4 @@ -= How to package Octave packages += Octave Packaging Guidelines == What is Octave? diff --git a/guidelines/modules/ROOT/pages/PHP.adoc b/guidelines/modules/ROOT/pages/PHP.adoc index 120e446..db807cc 100644 --- a/guidelines/modules/ROOT/pages/PHP.adoc +++ b/guidelines/modules/ROOT/pages/PHP.adoc @@ -1,3 +1,5 @@ += PHP Packaging Guidelines + __TOC__ Fedora Packaging Guidelines for PHP addon modules diff --git a/guidelines/modules/ROOT/pages/Perl.adoc b/guidelines/modules/ROOT/pages/Perl.adoc index 6f8f36d..004c78b 100644 --- a/guidelines/modules/ROOT/pages/Perl.adoc +++ b/guidelines/modules/ROOT/pages/Perl.adoc @@ -1,3 +1,5 @@ += Perl Packaging Guidelines + __TOC__ == License tag diff --git a/guidelines/modules/ROOT/pages/Python.adoc b/guidelines/modules/ROOT/pages/Python.adoc index 295765f..22d36e2 100644 --- a/guidelines/modules/ROOT/pages/Python.adoc +++ b/guidelines/modules/ROOT/pages/Python.adoc @@ -1,3 +1,5 @@ += Python Packaging Guidelines + __TOC__ == Python Version Support diff --git a/guidelines/modules/ROOT/pages/R.adoc b/guidelines/modules/ROOT/pages/R.adoc index f8a4004..cd445f9 100644 --- a/guidelines/modules/ROOT/pages/R.adoc +++ b/guidelines/modules/ROOT/pages/R.adoc @@ -1,3 +1,5 @@ += R Packaging Guidelines + __TOC__ == What is R? diff --git a/guidelines/modules/ROOT/pages/Ruby.adoc b/guidelines/modules/ROOT/pages/Ruby.adoc index b77d5e9..1cc1c85 100644 --- a/guidelines/modules/ROOT/pages/Ruby.adoc +++ b/guidelines/modules/ROOT/pages/Ruby.adoc @@ -1,3 +1,5 @@ += Ruby Packaging Guidelines + __TOC__ There are three basic categories of ruby packages: link:#RubyGems[ ruby gems], link:#Non-Gem_Packages[ non-gem ruby packages], and link:#ruby_applications[ applications written in ruby]. These guidelines contain sections common to all of these as well as sections which apply to each one individually. Be sure to read all the guidelines relevant to the type of ruby package you are building. diff --git a/guidelines/modules/ROOT/pages/Rust.adoc b/guidelines/modules/ROOT/pages/Rust.adoc index eb00561..63c5ed8 100644 --- a/guidelines/modules/ROOT/pages/Rust.adoc +++ b/guidelines/modules/ROOT/pages/Rust.adoc @@ -1,4 +1,4 @@ -= Rust += Rust Packaging Guidelines This document details best practices for packaging Rust crates. Note that the rust2rpm tool, available as a Fedora package or at https://pagure.io/fedora-rust/rust2rpm, automates many of these steps. It is advisable to try `+rust2rpm $crate+` first before attempting to write a specfile by hand.