From 7135d15a2b4db9ac5caedd4730ccbf29fa55d15d Mon Sep 17 00:00:00 2001 From: Ian Jackson Date: Thu, 29 Oct 2009 17:26:06 +0000 Subject: [PATCH 1/1] Improve comments about extending source-info.txt --- yarrg/Commods.pm | 28 +++++++++++++++++++++++++++- yarrg/db-idempotent-populate | 2 +- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/yarrg/Commods.pm b/yarrg/Commods.pm index 372fe16..f74571d 100644 --- a/yarrg/Commods.pm +++ b/yarrg/Commods.pm @@ -51,7 +51,33 @@ BEGIN { @EXPORT_OK = qw(); } -our $masterinfoversion= 2; # version we understand +our $masterinfoversion= 2; # version we understand. +# +# To extend the source-info.txt format: +# +# * Commods.pm:parse_info1 +# add code to parse new version +# +# * source-info.txt +# add new information +# +# If new data should NOT be in master-info.txt too: +# +# * update-master-info:process_some_info +# check that code for converting source-info to master-info +# removes the extra info; add code to remove it if necessary +# +# * db-idempotent-populate +# if database schema is extended, add code to copy data +# +# If new data DOES need to be in master-info.txt too: +# +# * Commods.pm:$masterinfoversion +# increment +# +# * update-master-info:process_some_info +# add code to convert new version to old, by removing +# extra info conditionally depending on version our %oceans; # eg $oceans{'Midnight'}{'Ruby'}{'Eta Island'}= $sources; our %clients; # eg $clients{'ypp-sc-tools'}= [ qw(last-page) ]; diff --git a/yarrg/db-idempotent-populate b/yarrg/db-idempotent-populate index 1d106f2..c4bd4a7 100755 --- a/yarrg/db-idempotent-populate +++ b/yarrg/db-idempotent-populate @@ -5,7 +5,7 @@ # # usage: ./db-idempotent-populate # creates or updates OCEAN-Oceanname.db -# from master-master.txt +# from source-info.txt # This is part of ypp-sc-tools, a set of third-party tools for assisting # players of Yohoho Puzzle Pirates. -- 2.30.2