Skip to content

Commit 6245b76

Browse files
authored
Merge pull request #860 from marionbarker/working-docs
Updates for version 3.4.x release
2 parents 7def6af + 9bd8d9c commit 6245b76

13 files changed

+17223
-137
lines changed

docs/browser/edit-browser.md

Lines changed: 174 additions & 65 deletions
Large diffs are not rendered by default.
95.3 KB
Loading

docs/browser/img/modify-build-loop-yml.svg

Lines changed: 2586 additions & 0 deletions
Loading

docs/browser/img/navigate-submodule-omnible.svg

Lines changed: 9252 additions & 0 deletions
Loading

docs/browser/img/prepare-workspace-patch.svg

Lines changed: 5111 additions & 0 deletions
Loading

docs/browser/phone-install.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,15 +82,43 @@ Once the app is available in *TestFlight*, you can adjust whether it is automati
8282

8383
Go back to the *TestFlight* app on your phone and tap on your app name in the list to see an expanded screen similar to the graphic below. The row to enable or disable automatic updates is highlighted in the graphic, which shows the feature disabled. This is recommended for all users.
8484

85-
* If you leave automatic update enabled (default), then whenever a new build is created and uploaded to *TestFlight* , it will be installed immediately.
86-
* WARNING: If you switch between Building with Browser and *Mac*, you must disable automatic update or Xcode will not be able to install to your phone.
85+
* If you leave automatic update enabled (default), then whenever a new build is created and uploaded to *TestFlight* , it will be installed immediately (see [Unexpected *TestFlight* Expiration](#unexpected-testflight-expiration))
86+
* WARNING: If you switch between Building with Browser and *Mac*, you must disable automatic update or Xcode will not be able to install to your phone
8787

8888
![enable or disable automatic update for Loop](img/testflight-auto-update.png){width="300"}
8989
{align="center"}
9090

9191
When you are ready to install, just open the *TestFlight* app and click Install to get the most recent build and then click Open when it completes the installation. All your settings and connections to CGM and Pump are maintained.
9292

93-
If you tap on the bottom row that says `Previous Builds`, highlighted by the dashed-green rectangle, you can view and choose an older build (as long as it has not expired).
93+
### Previous Builds
94+
95+
If you tap on the bottom row that says `Previous Builds`, highlighted by the dashed-green rectangle, you can view and choose an older (or lower version number) build (as long as it has not expired).
96+
97+
* In some cases, you need to do this to see the newest build
98+
* For example, it you build version 3.5.0 (`dev` branch) accidentally and then switched to 3.4.x (`main` branch), *TestFlight* shows you the 3.5.0 version on the screen and you need to go to previous builds to find your newer 3.4.x build
99+
100+
### Unexpected *TestFlight* Beta Expiration
101+
102+
!!! important "*Apple TestFlight* Bug"
103+
It doesn't happen to everyone but it has happened a few times over the years and only for people who have Automatic Update enabled for their *TestFlight* app.
104+
105+
Symptom:
106+
107+
* App has plenty of time before expiration
108+
* A new build becomes available, for example from the automatic monthly rebuild
109+
* User is told *Loop* Beta is not available
110+
111+
Solution:
112+
113+
* Open *TestFlight* and turn off automatic installation for your app
114+
* Install the previous version of the app on the phone manually (with monthly build, it should still be ok)
115+
* Manually start a new build (if there were updates you want to get)
116+
* Manually install the new update
117+
118+
More information:
119+
120+
* [Link 1: Apple forum](https://forums.developer.apple.com/forums/thread/720033){: target="_blank" }
121+
* [Link 2: Stackoverflow thread](https://stackoverflow.com/questions/74588716/testflight-beta-has-expired){: target="_blank" }
94122

95123
## *TestFlight* for a Child
96124

docs/build/build-dev-mac.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ There is a script to assist in building the `dev branch`. It gives you the optio
1717
/bin/bash -c "$(curl -fsSL \
1818
https://raw.githubusercontent.com/loopandlearn/lnl-scripts/main/BuildLoopDev.sh)"
1919
```
20-
Both the `dev branch` and the lightly tested branch of `dev` have Libre support.
2120

2221
### BuildLoopDev Other Branches
2322

docs/loop-3/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Two algorithm experiments are now available in the *Loop* app (version 3.4.0 or
4444
* The "switcher" patch is no longer compatible
4545
* The GBPA feature is intended to replace the functionality of that older customization and is controlled completely inside the *Loop* app
4646

47-
_<span translate="no">Glucose Based Partial Application</span>_ is only used when _Automatic Bolus_ (AB) is selected for _Temp Basal Only_ _Dosing Strategy_
47+
_<span translate="no">Glucose Based Partial Application</span>_ is only used when _Automatic Bolus_ (AB) is selected for _Dosing Strategy_
4848

4949
* This modification **does not affect the recommended dose**, only how quickly the recommended dose is automatically delivered
5050

docs/version/build-time-flag.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
## Overview
22

3-
Build-time features are not available with Loop 2.2.x.
4-
53
With Loop 3, some features are enabled or disabled by default but can be modified by adding a "flag" in the LoopConfigOverride.xcconfig file.
64

7-
If you use Build with Browser, these build-time features can be added to your copy of the LoopConfigOverride.xcconfig file. Use the pencil icon in that file on your copy of LoopWorkspace and then commit the change.
5+
## Modify the `Build Time Flags`
86

9-
If you use the Build with *Mac* Method, this is the same file used to automatically sign all your targets. You can edit the version in your LoopWorkspace folder (it shows up as the top item in the Xcode folder view) - or - if you use the build script, you can edit the copy found in ~/Downloads/BuildLoop after the first time you use the script. For that second case, the "flags" you add in ~/Downloads/BuildLoop/LoopConfigOverride.xcconfig are applied to all downloads created with the script.
7+
The `Build Time Flags` are available for both build methods:
108

11-
These flags are always upper case with underscore separating words for clarity, for example `MY_EXAMPLE_FLAG`. If you have more than one flag, they are separated by a space. Do not enter a line break between selections; in other words, do not hit return or enter. Xcode will automatically word-wrap the line for clarity. All values need to be on a single line.
9+
* **Build with Browser**
10+
* Edit the LoopConfigOverride.xcconfig file in your fork
11+
* Use the pencil icon in that file to make the modification shown below and commit the change to your fork
12+
* Do not try to open a pull request to LoopKit/LoopWorkspace - only modify your-github-username/LoopWorkspace version
13+
* **Build with *Mac* Method**
14+
* You edit the file used to automatically sign all your targets
15+
* You can edit the version in your LoopWorkspace folder (it shows up as the top item in the Xcode folder view) - or - if you use the build script, you can edit the copy found in ~/Downloads/BuildLoop after the first time you use the script.
16+
* If you edit `~/Downloads/BuildLoop/LoopConfigOverride.xcconfig`, the "flags" you add are applied to this download and all subsequent downloads created with the script.
1217

13-
!!! question "New Instructions"
14-
The instructions are more robust than earlier instructions that had you editing a line instead of adding new ones.
18+
These flags are always upper case with underscore separating words for clarity, for example `MY_EXAMPLE_FLAG`. If you have more than one flag, they are separated by a space. Do not enter a line break between selections; in other words, do not hit return or enter. Xcode will automatically word-wrap the line for clarity. All values need to be on a single line.
1519

1620
Copy the text below, add it to the end of your LoopConfigOverride.xcconfig file and then insert the desired flags in place of `MY_EXAMPLE_FLAG`. If you want more than one flag, separate them by a space.
1721

@@ -40,7 +44,7 @@ _Code After Modification_
4044
SWIFT_ACTIVE_COMPILATION_CONDITIONS = $(SWIFT_ACTIVE_COMPILATION_CONDITIONS) SIRI_DISABLED
4145
```
4246

43-
List of some flags and what they do:
47+
## Table of Build Time Flags
4448

4549
|FLAG|PURPOSE|
4650
|---------|---------|

0 commit comments

Comments
 (0)