| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
|---|
| 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
|---|
| 3 | |
|---|
| 4 | <html xmlns="http://www.w3.org/1999/xhtml"> |
|---|
| 5 | <head> |
|---|
| 6 | <meta name="generator" content= |
|---|
| 7 | "HTML Tidy for Linux/x86 (vers 1st December 2004), see www.w3.org" /> |
|---|
| 8 | |
|---|
| 9 | <title>FCM User Guide: Introduction</title> |
|---|
| 10 | <meta name="author" content="FCM development team" /> |
|---|
| 11 | <meta name="descriptions" content="User Guide - Introduction" /> |
|---|
| 12 | <meta name="keywords" content="FCM, user guide" /> |
|---|
| 13 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
|---|
| 14 | <link rel="stylesheet" type="text/css" href="style.css" /> |
|---|
| 15 | <script type="text/javascript" src="fcm.js"> |
|---|
| 16 | </script> |
|---|
| 17 | </head> |
|---|
| 18 | |
|---|
| 19 | <body onload= |
|---|
| 20 | "javascript: FCM.load('doc/user_guide/', null, [['.', 'FCM User Guide']]);"> |
|---|
| 21 | <div id="document-info"> |
|---|
| 22 | <address id="fcm-js-trail"></address> |
|---|
| 23 | |
|---|
| 24 | <address id="fcm-js-maintenance"></address> |
|---|
| 25 | </div> |
|---|
| 26 | |
|---|
| 27 | <h1>Introduction</h1> |
|---|
| 28 | |
|---|
| 29 | <p>This is the User Guide for the <em>Flexible Configuration Management</em> |
|---|
| 30 | system which is known as <em>FCM</em>. It is designed to tell you everything |
|---|
| 31 | you need to know if you want to develop code which has been configured within |
|---|
| 32 | FCM. In addition it also provides the extra information you will need if you |
|---|
| 33 | are system manager of a project within FCM.</p> |
|---|
| 34 | |
|---|
| 35 | <p>Note: some hyperlinks in this document lead to pages that are internal to |
|---|
| 36 | the Met Office, and so will generally not work when this document is viewed |
|---|
| 37 | externally. Please accept our apologies if this causes you any |
|---|
| 38 | inconvenience.</p> |
|---|
| 39 | |
|---|
| 40 | <p>This guide consists of the following sections:</p> |
|---|
| 41 | |
|---|
| 42 | <dl> |
|---|
| 43 | <dt><a href="overview.html">System Overview</a></dt> |
|---|
| 44 | |
|---|
| 45 | <dd>A brief description of the main features of FCM.</dd> |
|---|
| 46 | |
|---|
| 47 | <dt><a href="getting_started.html">Getting Started</a></dt> |
|---|
| 48 | |
|---|
| 49 | <dd>How to start using FCM. It includes a tutorial for you to work through |
|---|
| 50 | and familiarise yourself with some FCM activities.</dd> |
|---|
| 51 | |
|---|
| 52 | <dt><a href="code_management.html">Code Management System</a></dt> |
|---|
| 53 | |
|---|
| 54 | <dd>How to use the code management system to manage code changes.</dd> |
|---|
| 55 | |
|---|
| 56 | <dt><a href="working_practices.html">Code Management Working |
|---|
| 57 | Practices</a></dt> |
|---|
| 58 | |
|---|
| 59 | <dd>Recommended ways of working with the code management system.</dd> |
|---|
| 60 | |
|---|
| 61 | <dt><a href="extract.html">The Extract System</a></dt> |
|---|
| 62 | |
|---|
| 63 | <dd>How to extract code from the repository ready for building.</dd> |
|---|
| 64 | |
|---|
| 65 | <dt><a href="build.html">The Build System</a></dt> |
|---|
| 66 | |
|---|
| 67 | <dd>How to compile code using the build system.</dd> |
|---|
| 68 | |
|---|
| 69 | <dt><a href="system_admin.html">System Administration</a></dt> |
|---|
| 70 | |
|---|
| 71 | <dd>How to configure and maintain a new system within FCM.</dd> |
|---|
| 72 | |
|---|
| 73 | <dt><a href="command_ref.html">FCM Command Reference</a></dt> |
|---|
| 74 | |
|---|
| 75 | <dd>Detailed information about each of the <code>fcm</code> commands.</dd> |
|---|
| 76 | |
|---|
| 77 | <dt><a href="further_info.html">Further Information</a></dt> |
|---|
| 78 | |
|---|
| 79 | <dd>Where to find further information about FCM and about configuration |
|---|
| 80 | management in general.</dd> |
|---|
| 81 | |
|---|
| 82 | <dt>Annex:</dt> |
|---|
| 83 | |
|---|
| 84 | <dd> |
|---|
| 85 | <dl> |
|---|
| 86 | <dt><a href="annex_quick_ref.html">Quick reference</a></dt> |
|---|
| 87 | |
|---|
| 88 | <dd>A quick reference to many useful FCM code management system |
|---|
| 89 | commands.</dd> |
|---|
| 90 | |
|---|
| 91 | <dt><a href="annex_fcm_cfg.html">Declarations in FCM central/user |
|---|
| 92 | configuration file</a></dt> |
|---|
| 93 | |
|---|
| 94 | <dd>Detailed definitions of what declarations are allowed in a |
|---|
| 95 | central/user configuration file.</dd> |
|---|
| 96 | |
|---|
| 97 | <dt><a href="annex_ext_cfg.html">Declarations in FCM extract |
|---|
| 98 | configuration file</a></dt> |
|---|
| 99 | |
|---|
| 100 | <dd>Detailed definitions of what declarations are allowed in an extract |
|---|
| 101 | configuration file.</dd> |
|---|
| 102 | |
|---|
| 103 | <dt><a href="annex_bld_cfg.html">Declarations in FCM build |
|---|
| 104 | configuration file</a></dt> |
|---|
| 105 | |
|---|
| 106 | <dd>Detailed definitions of what declarations are allowed in a build |
|---|
| 107 | file.</dd> |
|---|
| 108 | </dl> |
|---|
| 109 | </dd> |
|---|
| 110 | </dl> |
|---|
| 111 | </body> |
|---|
| 112 | </html> |
|---|
