Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds versioning for Configuration.h & Configuration_adv.h #3609

Merged
merged 2 commits into from
Jun 16, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions Marlin/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
14 changes: 14 additions & 0 deletions Marlin/SanityCheck.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,20 @@
#error "Versions of Arduino IDE prior to 1.6.0 are no longer supported, please update your toolkit."
#endif

/**
* We try our best to include sanity checks for all the changes configuration
* directives because people have a tendency to use outdated config files with
* the bleding edge source code, but sometimes this is not enough. This check
* will force a minimum config file revision, otherwise Marlin will not build.
*/
#if ! defined(CONFIGURATION_H_VERSION) || CONFIGURATION_H_VERSION < REQUIRED_CONFIGURATION_H_VERSION
#error You are using an old Configuration.h file, update it before building Marlin.
#endif

#if ! defined(CONFIGURATION_ADV_H_VERSION) || CONFIGURATION_ADV_H_VERSION < REQUIRED_CONFIGURATION_ADV_H_VERSION
#error You are using an old Configuration_adv.h file, update it before building Marlin.
#endif

/**
* Marlin release, version and default string
*/
Expand Down
10 changes: 10 additions & 0 deletions Marlin/Version.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,16 @@
*/
#define STRING_DISTRIBUTION_DATE "2016-04-27 12:00"

/**
* Required minimum Configuration.h and Configuration_adv.h file versions.
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option on
* the configuration files.
*/
#define REQUIRED_CONFIGURATION_H_VERSION 010100
#define REQUIRED_CONFIGURATION_ADV_H_VERSION 010100

/**
* @todo: Missing documentation block
*/
Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/Felix/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/example_configurations/Felix/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/Felix/DUAL/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/Hephestos/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/example_configurations/Hephestos/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/Hephestos_2/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/example_configurations/Hephestos_2/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/K8200/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/example_configurations/K8200/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/RigidBot/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/example_configurations/RigidBot/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/SCARA/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/example_configurations/SCARA/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
Binary file not shown.
13 changes: 13 additions & 0 deletions Marlin/example_configurations/TAZ4/Configuration.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@
#ifndef CONFIGURATION_H
#define CONFIGURATION_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_H_VERSION 010100

#include "boards.h"
#include "macros.h"

Expand Down
13 changes: 13 additions & 0 deletions Marlin/example_configurations/TAZ4/Configuration_adv.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@
#ifndef CONFIGURATION_ADV_H
#define CONFIGURATION_ADV_H

/**
*
* ***********************************
* ** ATTENTION TO ALL DEVELOPERS **
* ***********************************
*
* You must increment this version number for every significant change such as,
* but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option.
*
* Note: Update also Version.h !
*/
#define CONFIGURATION_ADV_H_VERSION 010100

#include "Conditionals.h"

// @section temperature
Expand Down
Binary file not shown.
Loading