Komodo / KomodoEdit
Deze readme legt uit hoe je aan de slag kunt met het bouwen, gebruiken en ontwikkelen van de Komodo Edit broncode.
Hoewel de hoofdbron van Komodo Edit in deze repository staat, kun je ook de individuele component/addon repositories onder https://github.com/Komodo bekijken voor het geval je alleen aan een specifiek component wilt bijdragen. Dit bespaart je wat tijd en moeite omdat je dan niet het hele project hoeft te bouwen.
Inhoudsopgave
- Screenhot
- Download
- Feedback
- Bouwen van Komodo
- Bouwen op Windows
- Bouwen op Mac
- Bouwen op Linux
- Bouwen met Docker
- Bouwen Complicaties
Screenshot
Download
Je kunt Komodo Edit hier downloaden.
Feedback
Er zijn verschillende manieren om in contact te komen met de Komodo-deskundigen:
Github: https://github.com/Komodo/KomodoEdit
Forums: http://forum.komodoide.com/
Bug Tracker: https://github.com/Komodo/KomodoEdit/issues
IRC: irc://irc.mozilla.org/#komodo
Mailing Lists: komodo-discuss & komodo-beta & komodo-announce
Building Komodo
Merk op dat dit vereenvoudigde stappen zijn van het bouwproces, voor een meer diepgaande handleiding kijk op (verouderde) BUILD.txt.
Bouwen op Windows
- Voorwaarden
- Bouwstappen
Voorwaarden
-
Python >=2.7 (maar nog niet Python 3.x). U kunt ActivePython hier installeren.
-
Visual C++ 11.0 (aka Visual Studio 2012) en alle Platform SDK’s voor het bouwen van Mozilla met vc11 zoals hier beschreven.
-
Installeer versie 1.9.0 van het pakket “MozillaBuild-$ver.exe” in de standaard dir (d.w.z. “C:\mozilla-build”).
- Installeer de wget en hg directories
- Download versie 2.2.0 en installeer het in een tijdelijke directory, kopieer dan de wget directory van 2.2 naar de 1.9 installatie directory
.9 installatiedirectory
-
Installeer Perl <= 5.22
-
Installeer Mercurial
Zie http://developer.mozilla.org/en/docs/Windows_Build_Prerequisites voor meer details over de Windows voorvereisten. Het is echter de bedoeling dat de volgende stappen voldoende zijn om Komodo te bouwen.
Bouwstappen
-
Checkout Komodo Edit:
git clone https://github.com/Komodo/KomodoEdit.git
-
Gebruik de command line, enter je checkout directory en voer uit:
cd mozilla setenv-moz-msvc11.bat python build.py configure -k 11.10 python build.py distclean all
This will configure and build mozilla and can take anywhere from 30 minutest to several hours to complete (depending on your specs). Voor de meeste moderne machines zou het ongeveer een uur moeten duren.
-
Nadat Mozilla succesvol is gebouwd, ga terug naar de hoofd repo directory en bouw komodo:
cd .. set PATH=util\black;%PATH% bk configure -V 11.10.0-devel # --without-binary-dbgp-clients bk build
Dit zou aanzienlijk minder tijd in beslag moeten nemen dan het bouwen van Mozilla.
-
Als het bouwen klaar is kun je Komodo gewoon draaien door
bk run
Als je wijzigingen aanbrengt in de broncode moet je opnieuw bk build
draaien, of gewoon bk build && bk run
om snel weer in Komodo te komen. Latere builds zouden een stuk sneller moeten gaan omdat veel van de gecompileerde gegevens in de cache staan.
Bouwen op Mac
- Mac vereisten
- Bouwstappen
Mac vereisten
-
Python >=2.7 (maar nog niet Python 3.x). U kunt ActivePython van hieruit installeren.
Als u liever de Python builds van python.org gebruikt zou dat ook voldoende moeten zijn.
-
Xcode 6.4(SDK 10.9 & 10.10). Voor 8.0 zie hieronder. U kunt versie 6.4 downloaden van de downloadsite voor ontwikkelaars.
-
MacOSX10.10.sdk of ouder
-
IDE ALLEEN SDK 10.8 voor code Intel. Te vinden in Xcode 5.1.1
-
Als u andere versies van Xcode hebt/nodig hebt geïnstalleerd, kunt u
xcode-select
gebruiken om de actieve Xcode te wijzigen:$ xcode-select -s /Path/To/Xcode\ 6.4.app/
-
Xcode Command Line Tools.
Open de Xcode-voorkeuren en selecteer en installeer vervolgens op het tabblad Downloads deCommand Line Tools.
-
MacPorts. (Opmerking: Fink kan ook werken, maar de meeste bouwtests en instructies worden uitgevoerd met MacPorts.)
-
autoconf v2.13. Als MacPorts is geïnstalleerd, hoeft u alleen maar
sudo port install autoconf213
-
te controleren of u clang of gcc 4.2 (of hoger) gebruikt
Zie http://developer.mozilla.org/en/docs/Mac_OS_X_Build_Prerequisitesfor voor meer details over de vereisten voor het bouwen van Mac OS X. Het volgen van de bovenstaande stappen is echter voldoende om Komodo te kunnen bouwen.
Xcode 8 Prerequisites
Officieel ondersteunen we Xcode 8 niet, maar het is mogelijk om Komodounder Xcode 8 te bouwen met behulp van een aantal extra stappen.
- Kopieer de 10.8 en 10.9 SDK’s van een oudere XCode installatie, ze zouden moeten staan in:Xcode.app/Contents/Developer/Platforms/macOSX.platform/
- Stel MinimumSDKVersion in op 10.9 in Xcode.app/Contents/Developer/Platforms/macOSX.platform/Info.plist
- Zorg ervoor dat u ccache 3 gebruikt.1 (latere versies zullen breken)
- Configureer Mozilla met
--options=disable-webrtc
Bouwstappen
-
Checkout Komodo Edit:
git clone https://github.com/Komodo/KomodoEdit.git
-
Gebruik de terminal, ga naar je checkout directory en voer uit:
1) cd komodo/mozilla 2) python build.py configure -k 10.10 3) python build.py all or python build.py distclean all (to delete and re-download Mozilla again)
This will configure and build mozilla and can take anywhere from 30 minutes to several hours to complete (depending on your specs). Voor de meeste moderne machines zou het ongeveer een uur moeten duren.
**Bouwen met GCC 5.0 en hoger **
Als u GCC 5.0 gebruikt, kan het bouwen mislukken. Als dat het geval is, moeten er wijzigingen worden aangebracht in twee bestanden. Als u echter voor de eerste keer een schone build uitvoert, moet u toestaan dat dit deel van de build eerst faalt. De bestanden staan namelijk in het Mozilla-gedeelte van de build, dat eerst moet worden gedownload.
Deze bestanden moeten worden gewijzigd:
- /KomodoEdit/mozilla/build/moz3500-ko9.10/mozilla/configure.in
@@ -7509,8 +7509,6 @@ eval $(CXX="$CXX" HOST_CXX="$HOST_CXX" $PYTHON -m mozbuild.configure.libstdcxx) AC_SUBST(MOZ_LIBSTDCXX_TARGET_VERSION) AC_SUBST(MOZ_LIBSTDCXX_HOST_VERSION)+ CXXFLAGS="$CXXFLAGS -D_GLIBCXX_USE_CXX11_ABI=0"+ HOST_CXXFLAGS="$HOST_CXXFLAGS -D_GLIBCXX_USE_CXX11_ABI=0"fi
Zie bug #1153109 in Mozilla’s bugdatabase voor meer informatie.
- /KomodoEdit/mozilla/build/moz3500-ko9.10/mozilla/dom/ipc/Blob.cpp
@@ -3874,7 +3874,7 @@// Make sure we can't overflow.if (NS_WARN_IF(UINT64_MAX - aLength < aStart)) { ASSERT_UNLESS_FUZZING();- return nullptr;+ return false;}ErrorResult errorResult;@@ -3883,7 +3883,7 @@if (NS_WARN_IF(aStart + aLength > blobLength)) { ASSERT_UNLESS_FUZZING();- return nullptr;+ return false;}
Zie Porten naar GCC 5 voor meer informatie.
-
Nadat mozilla succesvol is gebouwd, ga dan terug naar de hoofd repo directory en bouw komodo:
cd .. export PATH=`pwd`/util/black:$PATH # Komodo's "bk" build tool git submodule update --init git submodule update --remote bk configure -V 10.10.0-devel bk build
Dit zou aanzienlijk minder tijd in beslag moeten nemen dan het bouwen van Mozilla.
-
Als het bouwen is voltooid kun je Komodo gewoon draaien door
bk run
Als je wijzigingen aanbrengt in de broncode moet je opnieuw bk build
draaien, of gewoon bk build && bk run
om snel weer in Komodo te komen. Latere builds zouden een stuk sneller moeten gaan omdat veel van de gecompileerde data in de cache staat.
Bouwen op Linux
Linux instructies
Bouwen met Docker
De makkelijkste manier om te beginnen is om onze Docker image te gebruiken, dit zal u in principe voorzien van een Ubuntu 12.04 gebaseerde build van Komodo.
Na het klonen van de repository navigeert u eenvoudigweg naar {repo}/util/docker
en checkout ./docklet --help
Om de docker image te gebruiken moet u natuurlijk Docker geïnstalleerd hebben en X11 forwarding ingeschakeld hebben in uw SSH client (zou standaard moeten werken op de meeste Linux distro’s).
Prepare Docker Image
- Build de docker image:
./util/docker/docklet image
- Start uw container:
./util/docker/docklet start
- SSH in uw container om te beginnen werken:
./util/docker/docklet ssh
Je project bestanden worden gemount op /komodo/dev
NOTE – als je een update doet vanaf een vorige versie waar je project bestanden op /root/komodo
stonden, moet je de rechten van je Komodo project en profiel mappen aanpassen. I.e.g.:
chown -R <my-username>:<my-group> <my-project-location>chown -R <my-username>:<my-group> ~/.komodoide
Je moet ook opnieuw bouwen (distclean mozilla en komodo).
Bouw stappen
Als je image is voorbereid kun je de bouw stappen voor linux volgen zoals hierboven beschreven. Je zal deze uitvoeren vanuit de docker container, dus ssh init met het commando hierboven en voer dan de commando’s uit /komodo/dev
Running
Als het bouwen klaar is verlaat je de container (exit
) en kun je Komodo uitvoeren met
./util/docker/docklet run
Om Komodo opnieuw te bouwen (na het aanbrengen van wijzigingen) en het opnieuw te draaien kunt u
./util/docker/docklet build run
Als uw wijzigingen niet worden gereflecteerd moet u misschien uw build opschonen, Gebruik hiervoor
./util/docker/docklet clean
Of doe het in één keer (clean, build en run)
./util/docker/docklet clean build run
Complicaties bij het bouwen
Als er fouten optreden tijdens uw eerste keer bouwen en het is niet duidelijk hoe u het probleem zelf kunt oplossen, raadpleeg dan de sectie Feedback over hoe u contact met ons kunt opnemen.
Merk op dat als er bouw complicaties optreden nadat u uw repo heeft bijgewerkt met de laatste wijzigingen, u misschien uw lokale cache moet wissen omdat deze conflicteert met de nieuwe wijzigingen, om dit te doen voert u bk distclean
uit voordat u uw bouw stappen uitvoert.
Pro-Tips
Bouw een enkel stuk
Soms is bk build
te veel en bk build quick
is niet genoeg. Als bk build quick
uw wijzigingen niet lijkt op te pikken, probeer dan bk build
op het stuk in kwestie te richten.
Voorbeeld
bk build build/release/modules/places #this will build the places module only
NOOT: Vertrouw niet op deze methode, want bk build quick
is sneller en doet in sommige gevallen enkele stappen die het bovenstaande voorbeeld niet zal uitvoeren. Gebruik het als een laatste poging voordat je bk distclean && bk build
probeert.